Update Contact Property

PUT

/v1/contact-property-definitions/id

Updates an existing custom property definition's display name, required flag, and (for Select type) its list of options.

⚠️ type cannot be changed here — there's no type field on this request. A property created as Text stays Text forever; changing its type requires deleting and recreating it (see Delete Contact Property for the soft-delete details and data-loss implications).

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.voxa.sa/v1/contact-property-definitions/id' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Status3",
    "isRequired": true,
    "selectOptions": [
        {
            "value": "Lead",
            "color": "#FF5733"
        },
        {
            "value": "Customer",
            "color": "#33FF57"
        },
        {
            "value": "VIP",
            "color": "#5733FF"
        },
        {
            "value": "Churned",
            "color": "#888888"
        }
    ]
}'

Response Example

{
    "workspaceId": "string",
    "name": "string",
    "key": "string",
    "type": 0,
    "isRequired": true,
    "selectOptions": [
        "string"
    ],
    "lastModificationTime": "string",
    "lastModifierId": "string",
    "creationTime": "string",
    "creatorId": "string",
    "id": "string"
}

Modified at 2026-06-21 13:13:05

Create Contact Property

Delete Contact Property