curl --request POST \
--url https://{host}/member/v1/custom-properties/definitions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "tier",
"displayName": "Loyalty Tier",
"dataType": "string"
}
]
'{
"name": "<string>",
"message": "<string>",
"details": null
}{
"name": "<string>",
"message": "<string>",
"details": null
}{
"name": "<string>",
"message": "<string>",
"details": null
}Registers one or more custom property definitions
POST
/
v1
/
custom-properties
/
definitions
curl --request POST \
--url https://{host}/member/v1/custom-properties/definitions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "tier",
"displayName": "Loyalty Tier",
"dataType": "string"
}
]
'{
"name": "<string>",
"message": "<string>",
"details": null
}{
"name": "<string>",
"message": "<string>",
"details": null
}{
"name": "<string>",
"message": "<string>",
"details": null
}Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Body
application/jsontext/jsonapplication/*+json
Machine-readable property key (max 100 chars, must be unique)
Required string length:
1 - 100Human-readable label (max 255 chars)
Required string length:
1 - 255One of: string, number, date, boolean, string[], number[], date[], boolean[]
Minimum string length:
1Response
OK
Last modified on August 10, 2026