Codes

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

Body

application/json

externalIdstringRequired

code's external id

namestringRequired

code's name

descriptionstringRequired

code's description, can be empty

codeTypeExternalIdstringRequired

code's type's external id

orderingSequencestring | nullableOptional

ordering sequence for UI sorting (alphanumeric)

groupstring | nullableOptional

group identifier for categorizing codes

isDisabledboolean | nullableOptional

whether the code is disabled, added from ingestion process

Responses

201Success

post

/api/v1/customers/{customerId}/codes/import

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/codes/import HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "externalId": "text",
  "name": "text",
  "description": "text",
  "codeTypeExternalId": "text",
  "orderingSequence": "text",
  "group": "text",
  "isDisabled": true
}

201Success

No content

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

Query parameters

isInitialbooleanOptional

Body

application/json

Responses

201Success

post

/api/v1/customers/{customerId}/codes/batch

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/codes/batch HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "codes": [
    {
      "externalId": "text",
      "name": "text",
      "description": "text",
      "codeTypeExternalId": "text",
      "orderingSequence": "text",
      "group": "text",
      "isDisabled": true
    }
  ]
}

201Success

No content