Custom Attribute
The UUID of the custom attribute to retrieve
Partner API Key
Partner API Secret
The custom attribute has been successfully retrieved.
Unique identifier
Creation timestamp
Last update timestamp
The name of the custom attribute.
Description of the custom attribute.
nullThe type of the custom attribute.
The target type of the custom attribute.
Whether the custom attribute should be automatically detected during analysis.
Invalid input format.
Unauthorized
CustomAttribute not found.
Partner API Key
Partner API Secret
Pagination limit
10Page to retrieve
1The custom attributes have been successfully listed.
Invalid input format.
Unauthorized
Partner API Key
Partner API Secret
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
The ID of the custom attribute to assign
The ID of the target entity to assign the custom attribute to
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.
The attribute has been successfully assigned.
Unique identifier
Creation timestamp
Last update timestamp
ID of the related custom attribute.
The type of the custom attribute.
Determines if the value was auto-detected
The ID of the possible value selected if applicable Only used for select type custom attributes, null otherwise
nullSubmitted text value if applicable Only used for text type custom attributes, null otherwise
nullSubmitted numeric value if applicable Only used for rating type custom attributes, null otherwise
nullThe 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
Invalid input format.
Unauthorized
Customer or CustomAttribute not found.
Partner API Key
Partner API Secret
No content
Invalid input format.
Unauthorized
Attribute value not found.
No content
Partner API Key
Partner API Secret
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
The ID of the custom attribute to assign
The ID of the target entity to assign the custom attribute to
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.
The attribute has been successfully assigned.
Unique identifier
Creation timestamp
Last update timestamp
ID of the related custom attribute.
The type of the custom attribute.
Determines if the value was auto-detected
The ID of the possible value selected if applicable Only used for select type custom attributes, null otherwise
nullSubmitted text value if applicable Only used for text type custom attributes, null otherwise
nullSubmitted numeric value if applicable Only used for rating type custom attributes, null otherwise
nullThe 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
Invalid input format.
Unauthorized
Purchase or CustomAttribute not found.
Partner API Key
Partner API Secret
No content
Invalid input format.
Unauthorized
Attribute value not found.
No content
Partner API Key
Partner API Secret
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
The ID of the custom attribute to assign
The ID of the target entity to assign the custom attribute to
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.
The attribute has been successfully assigned.
Unique identifier
Creation timestamp
Last update timestamp
ID of the related custom attribute.
The type of the custom attribute.
Determines if the value was auto-detected
The ID of the possible value selected if applicable Only used for select type custom attributes, null otherwise
nullSubmitted text value if applicable Only used for text type custom attributes, null otherwise
nullSubmitted numeric value if applicable Only used for rating type custom attributes, null otherwise
nullThe 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
Invalid input format.
Unauthorized
Feedback or CustomAttribute not found.
Partner API Key
Partner API Secret
No content
Invalid input format.
Unauthorized
Attribute value not found.
No content
Last updated

