Configuration APICustom Fields

Create a custom field for a customer

Requires the CUSTOM_FIELD.CREATE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
referencestringRequiredformat: "^\S+$"0-256 characters
resource_typeenumRequired
integration_idstringRequired
The resource ID of the integration.
integration_referencestringRequiredformat: "^\S+$"0-256 characters
The reference of the integration.
namestring or nullOptional
descriptionstring or nullOptional
multiple_valuesboolean or nullOptional
unique_valueboolean or nullOptional
copy_value_to_invoiceboolean or nullOptional
typeenum or nullOptional
Allowed values:
enum_valueslist of strings or nullOptional

Response

Created
referencestringformat: "^\S+$"0-256 characters
resource_typeenum
integration_idstring
The resource ID of the integration.
integration_referencestringformat: "^\S+$"0-256 characters
The reference of the integration.
object_typestring or nullRead-only
idstring or nullRead-only
namestring or null
descriptionstring or null
multiple_valuesboolean or null
unique_valueboolean or null
copy_value_to_invoiceboolean or null
typeenum or null
Allowed values:
enum_valueslist of strings or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error