Create Contact Property

POST

/v1/contact-property-definitions

Defines a new custom property field for the workspace (the schema, not a value) — e.g., creating a "Possible Client" select field that can then be set per-contact via PUT /v1/contacts/{contactId}/properties/{propertyId}.

⚠️ Keep property names under ~50 characters. Very long names risk colliding or breaking that generation, and nothing protects against it.

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

Returns the created property definition.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/contact-property-definitions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "TEST",
    "type": 1,
    "isRequired": false
}'

Response Example

{
    "workspaceId": "d307b8...............",
    "name": "Noshy",
    "key": "noshy",
    "type": 1,
    "isRequired": false,
    "selectOptions": [],
    "lastModificationTime": null,
    "lastModifierId": null,
    "creationTime": "2026-06-21T11:36:39.2230722+00:00",
    "creatorId": null,
    "id": "3a21fc..............."
}

Modified at 2026-06-21 12:18:56

Contact Properties Statistics

Update Contact Property