For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom Attribute

Get a custom attribute by ID

get
Query parameters
idstringRequired

The UUID of the custom attribute to retrieve

Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
200

The custom attribute has been successfully retrieved.

application/json
idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

namestringRequired

The name of the custom attribute.

descriptionstring · nullableRequired

Description of the custom attribute.

Default: null
typestring · enumRequired

The type of the custom attribute.

Possible values:
targetTypestring · enumRequired

The target type of the custom attribute.

Possible values:
autoDetectbooleanRequired

Whether the custom attribute should be automatically detected during analysis.

get/partners/custom-attribute

List custom attributes

post
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10
pagenumber · min: 1Optional

Page to retrieve

Default: 1
Responses
201

The custom attributes have been successfully listed.

application/json
post/partners/custom-attribute/list

Assigns a custom attribute to a customer.

post
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
eraseExistingValuesbooleanOptional

Whether to erase existing custom attribute values. If true, all existing values will be deleted before assigning the newly value(s). If false, the newly value(s) will be assigned in addition to any existing values. This option is only used for multi-select type custom attributes, where you may want to keep existing values while adding new ones. @default true

attributestring · uuidRequired

The ID of the custom attribute to assign

targetstring · uuidRequired

The ID of the target entity to assign the custom attribute to

valuesstring[] · min: 1Required

The values to assign to the custom attribute. For attributes with possible values, these should be the ID(s) of the possible value(s). For free text attributes, it should be the raw string value. For free number attributes, it should be the raw number value as string.

Responses
201

The attribute has been successfully assigned.

application/json
idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

attributestringRequired

ID of the related custom attribute.

typestring · enumRequired

The type of the custom attribute.

Possible values:
autoDetectedbooleanRequired

Determines if the value was auto-detected

fromPossibleValuestring · nullableRequired

The ID of the possible value selected if applicable Only used for select type custom attributes, null otherwise

Default: null
textstring · nullableRequired

Submitted text value if applicable Only used for text type custom attributes, null otherwise

Default: null
ratingstring · nullableRequired

Submitted numeric value if applicable Only used for rating type custom attributes, null otherwise

Default: null
valuestringRequired

The value of the custom attribute as string, which can be either:

  • The text value for text type custom attributes
  • The numeric value for rating type custom attributes
  • The value of the selected possible value for select type custom attributes
post/partners/custom-attribute/customer

Unassigns a custom attribute value from a customer entity.

delete
Query parameters
idstringRequired
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
200Success

No content

delete/partners/custom-attribute/customer

No content

Assigns a custom attribute to a purchase.

post
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
eraseExistingValuesbooleanOptional

Whether to erase existing custom attribute values. If true, all existing values will be deleted before assigning the newly value(s). If false, the newly value(s) will be assigned in addition to any existing values. This option is only used for multi-select type custom attributes, where you may want to keep existing values while adding new ones. @default true

attributestring · uuidRequired

The ID of the custom attribute to assign

targetstring · uuidRequired

The ID of the target entity to assign the custom attribute to

valuesstring[] · min: 1Required

The values to assign to the custom attribute. For attributes with possible values, these should be the ID(s) of the possible value(s). For free text attributes, it should be the raw string value. For free number attributes, it should be the raw number value as string.

Responses
201

The attribute has been successfully assigned.

application/json
idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

attributestringRequired

ID of the related custom attribute.

typestring · enumRequired

The type of the custom attribute.

Possible values:
autoDetectedbooleanRequired

Determines if the value was auto-detected

fromPossibleValuestring · nullableRequired

The ID of the possible value selected if applicable Only used for select type custom attributes, null otherwise

Default: null
textstring · nullableRequired

Submitted text value if applicable Only used for text type custom attributes, null otherwise

Default: null
ratingstring · nullableRequired

Submitted numeric value if applicable Only used for rating type custom attributes, null otherwise

Default: null
valuestringRequired

The value of the custom attribute as string, which can be either:

  • The text value for text type custom attributes
  • The numeric value for rating type custom attributes
  • The value of the selected possible value for select type custom attributes
post/partners/custom-attribute/purchase

Unassigns a custom attribute value from a purchase entity.

delete
Query parameters
idstringRequired
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
200Success

No content

delete/partners/custom-attribute/purchase

No content

Assigns a custom attribute to a feedback.

post
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
eraseExistingValuesbooleanOptional

Whether to erase existing custom attribute values. If true, all existing values will be deleted before assigning the newly value(s). If false, the newly value(s) will be assigned in addition to any existing values. This option is only used for multi-select type custom attributes, where you may want to keep existing values while adding new ones. @default true

attributestring · uuidRequired

The ID of the custom attribute to assign

targetstring · uuidRequired

The ID of the target entity to assign the custom attribute to

valuesstring[] · min: 1Required

The values to assign to the custom attribute. For attributes with possible values, these should be the ID(s) of the possible value(s). For free text attributes, it should be the raw string value. For free number attributes, it should be the raw number value as string.

Responses
201

The attribute has been successfully assigned.

application/json
idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

attributestringRequired

ID of the related custom attribute.

typestring · enumRequired

The type of the custom attribute.

Possible values:
autoDetectedbooleanRequired

Determines if the value was auto-detected

fromPossibleValuestring · nullableRequired

The ID of the possible value selected if applicable Only used for select type custom attributes, null otherwise

Default: null
textstring · nullableRequired

Submitted text value if applicable Only used for text type custom attributes, null otherwise

Default: null
ratingstring · nullableRequired

Submitted numeric value if applicable Only used for rating type custom attributes, null otherwise

Default: null
valuestringRequired

The value of the custom attribute as string, which can be either:

  • The text value for text type custom attributes
  • The numeric value for rating type custom attributes
  • The value of the selected possible value for select type custom attributes
post/partners/custom-attribute/feedback

Unassigns a custom attribute value from a feedback entity.

delete
Query parameters
idstringRequired
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
200Success

No content

delete/partners/custom-attribute/feedback

No content

Last updated