# Custom Field API

Version: v3

## Servers

Sandbox URL
```
https://api-ext-sboxmeta.partners.spotnana.com
```

## Security

### Bearer

Type: http
Scheme: bearer

## Download OpenAPI description

[Custom Field API](https://developer.spotnana.com/_bundle/openapi/CustomFieldApi.yaml)

## Custom Field V3

APIs to manage company custom fields.

### Reorder custom fields

 - [POST /v3/companies/{companyId}/custom-fields/reorder](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/reordercustomfields.md)

### Update custom field status

 - [PATCH /v3/companies/{companyId}/custom-fields/update-status](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/updatecustomfieldstatus.md)

### Create custom field

 - [POST /v3/companies/{companyId}/custom-fields](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/createcustomfieldv3.md): This endpoint creates a custom field.

### Update custom field

 - [PUT /v3/companies/{companyId}/custom-fields/{customFieldId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/updatecustomfieldv3.md): This endpoint updates a custom field.

### Get custom field

 - [GET /v3/companies/{companyId}/custom-fields/{customFieldId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/readcustomfieldv3.md): This endpoint gets a custom field.

### Delete custom field

 - [DELETE /v3/companies/{companyId}/custom-fields/{customFieldId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/deletecustomfieldv3.md): This endpoint deletes a custom field.

### List custom field

 - [POST /v3/companies/{companyId}/custom-fields/list](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/listcustomfieldv3.md)

### Update option for the given options group

 - [PATCH /v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/updatecustomfieldoptiongroupv3.md): Updates (replaces) all the options of the given group with the provided ones.

### Upload file of options to be processed

 - [POST /v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/bulkuploadoptions.md)

### Create custom field arm

 - [POST /v3/companies/{companyId}/custom-fields/{customFieldId}/arms](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/createarm.md): This endpoint creates a custom field arm.

### Update arm

 - [PUT /v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/updatearm.md): This endpoint updates an arm.

### Get arm

 - [GET /v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/getarm.md): This endpoint gets an arm.

### Delete arm

 - [DELETE /v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/deletearm.md): This endpoint deletes an arm.

### List arms

 - [POST /v3/companies/{companyId}/custom-fields/{customFieldId}/arms/list](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/listarms.md)

### Get options for a custom field.

 - [POST /v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}/option-list](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/getcustomfieldv3optionlist.md)

### Get applicable custom fields

 - [POST /v3/applicable-custom-fields](https://developer.spotnana.com/openapi/customfieldapi/custom-field-v3/getapplicablecustomfields.md)