Powered by Redocly

Custom fields

Configure custom customer attributes.

Custom field

A custom field allows you to describe what a custom field of a customer is used for via a label. Only custom fields that have a label are shown per customer in your Partner Portal. There are only 10 custom fields available.

id
integer <int32> [ 1 .. 10 ]

Custom field identifier.

label
required
string [ 0 .. 50 ] characters

Custom field label. Determines the display name in the Partner Portal for a customer's custom field.

{
  • "id": 1,
  • "label": "ERP administration code"
}

Retrieve all custom fields

Retrieve a list of custom fields.

SecurityOAuth2 and ApiKey
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Custom field) >= 0 items

List of custom fields.

Array (>= 0 items)
id
integer <int32> [ 1 .. 10 ]

Custom field identifier.

label
required
string [ 0 .. 50 ] characters

Custom field label. Determines the display name in the Partner Portal for a customer's custom field.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/customers/custom-fields
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve a single custom field

Retrieve a single custom field by its identifier.

SecurityOAuth2 and ApiKey
Request
path Parameters
custom-field-id
required
integer <int32>

The identifier of the custom field.

Responses
200

Successful response.

Response Schema: application/json
id
integer <int32> [ 1 .. 10 ]

Custom field identifier.

label
required
string [ 0 .. 50 ] characters

Custom field label. Determines the display name in the Partner Portal for a customer's custom field.

default

An error occurred - see status code and problem response for more information.

get/v2/customers/custom-fields/{custom-field-id}
Response samples
application/json
{
  • "id": 1,
  • "label": "ERP administration code"
}

Update a custom field

Update the settings for a custom field.

SecurityApiKey and OAuth2
Request
path Parameters
custom-field-id
required
integer <int32>

The identifier of the custom field.

Request Body schema: application/json
required

The custom field settings you want to update.

label
required
string [ 0 .. 50 ] characters

Custom field label. Determines the display name in the Partner Portal for a customer's custom field.

Responses
200

Successful response.

Response Schema: application/json
id
integer <int32> [ 1 .. 10 ]

Custom field identifier.

label
required
string [ 0 .. 50 ] characters

Custom field label. Determines the display name in the Partner Portal for a customer's custom field.

default

An error occurred - see status code and problem response for more information.

put/v2/customers/custom-fields/{custom-field-id}
Request samples
application/json
{
  • "label": "ERP administration code"
}
Response samples
application/json
{
  • "id": 1,
  • "label": "ERP administration code"
}
➔ Next to Employees