Skip to content
API reference
/
Custom fields
/
/
Upload file of options to...

Custom Field API (v3)

Download OpenAPI description
CustomFieldApi.json
CustomFieldApi.yaml
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/customfieldapi

Custom Field V3

APIs to manage company custom fields.

Operations

Update option for the given options group

Request

Updates (replaces) all the options of the given group with the provided ones.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
customFieldIdstring(uuid)required

Identifier for custom field.

Example: 4974a66b-7493-4f41-908c-58ba81093947
optionGroupIdstring(uuid)required

Identifier for the options group

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
toUpdateArray of objects(CustomFieldV3Option)

Array of option to insert or update. Any existing option with same name will be updated and if there is no exiting item having same name as specified, then a new option will be inserted.

toDeleteArray of strings

Array of option that need to be deleted

Example: ["XC"]
curl -i -X PATCH \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/4974a66b-7493-4f41-908c-58ba81093947/option-groups/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "toUpdate": [
      {
        "name": "XC",
        "description": "Air exchange code",
        "additionalInfos": [
          {
            "type": "VARIABLE",
            "name": "LLF"
          }
        ],
        "translatedName": "XC",
        "translatedDescription": "Código de intercambio de aire"
      }
    ],
    "toDelete": [
      "XC"
    ]
  }'

Responses

Updated Successfully

Response
No content

Upload file of options to be processed

Request

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
customFieldIdstring(uuid)required

Identifier for custom field.

Example: 4974a66b-7493-4f41-908c-58ba81093947
optionGroupIdstring(uuid)required

Identifier for the options group

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodymultipart/form-datarequired
filestring(binary)

File of bulk records

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/4974a66b-7493-4f41-908c-58ba81093947/option-groups/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

Bodyapplication/json
taskIdstring(uuid)required

ID corresponding to the resulting upload task

Response
application/json
{
  "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8"
}

Create custom field arm

Request

This endpoint creates a custom field arm.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
customFieldIdstring(uuid)required

Identifier for custom field.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
namestringrequired

Name of the arm.

Example: "US Employee"
audiencesArray of objects(Audience)
Default []
actionAutoOption (object) or UserOptionCreateRequest (object)(CustomFieldActionCreateRequest)required
One of:

An automatic or a user action to select one of the items as a response to the field.

action.​typestringrequired
Default "AUTO"
Example: "AUTO"
action.​hiddenboolean

Whether this code will be hidden to the user.

Default false
Example: true
action.​descriptionstring

Description of the code.

Example: "Lower fare declined"
action.​namestringrequired

Code which represents the auto selected option for the custom field.

Example: "LD"
action.​additionalInfosArray of objects(AdditionalInfo)
Default []
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/4974a66b-7493-4f41-908c-58ba81093947/arms \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "US Employee",
    "audiences": [],
    "action": {
      "type": "AUTO",
      "hidden": true,
      "description": "Lower fare declined",
      "name": "LD",
      "additionalInfos": []
    }
  }'

Responses

Created

Bodyapplication/json
armIdstring(uuid)required

Arm id.

optionGroupIdstring(uuid)

Option group id if option source of arm is manual.

Response
application/json
{
  "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
  "optionGroupId": "a12319da-5fb4-44d5-ad00-21b6acdfac9e"
}
Copyright © 2026 Spotnana Technology, Inc.