Skip to content
API reference
/
Custom fields
/
/
Delete arm

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

Get arm

Request

This endpoint gets an 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
armIdstring(uuid)required

Identifier for arm.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/4974a66b-7493-4f41-908c-58ba81093947/arms/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

Arm id.

namestringrequired

Name of the arm.

Example: "US Employee"
audiencesArray of objects(Audience)
Default []
actionAutoOption (object) or UserOption (object)(CustomFieldAction)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 []
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "US Employee",
  "audiences": [],
  "action": {
    "type": "AUTO",
    "hidden": true,
    "description": "Lower fare declined",
    "name": "LD",
    "additionalInfos": []
  }
}

Delete arm

Request

This endpoint deletes an 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
armIdstring(uuid)required

Identifier for arm.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X DELETE \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/4974a66b-7493-4f41-908c-58ba81093947/custom-fields/4974a66b-7493-4f41-908c-58ba81093947/arms/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Deleted Successfully

Response
No content

List arms

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
Bodyapplication/jsonrequired
searchTextstring

Search text to filter the ARMs.

filterobject(ListArmsFilter)
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/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "string",
    "filter": {
      "tripUsageTypes": [
        "STANDARD"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
armsArray of objects(Arm)
Response
application/json
{
  "arms": [
    { … }
  ]
}
Copyright © 2026 Spotnana Technology, Inc.