1. Contact Properties
Hatif
  • Account API
    • Service Login
      POST
  • Channels API
    • Get Channels
      GET
  • Whatsapp API
    • Send Text
      POST
    • Send Template
      POST
  • Contact
    • Set Property Value on Contact
      PUT
    • Search Contacts [Complex]
      POST
    • Delete Property Value on Contact
      DELETE
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contacts
      GET
    • Get Contact By Id
      GET
    • Delete Contact
      DELETE
    • Create Bulk Contacts vCards
      POST
    • Create Contact
      POST
    • Get Contacts Search
      POST
    • Contacts History
      GET
  • Contact Properties
    • List Contact Properties
      GET
    • Delete Contact Property
      DELETE
    • Update Contact Property
      PUT
    • Create Contact Property
      POST
    • Contact Properties Statistics
      GET
  • Support API
    • Upload Audio File
      POST
  • Outbound IVR API
    • Create Outbound IVR
      POST
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
    • List Conversations
    • Create Conversation
    • Assign Conversation
    • Get Conversation
  • Tags API
    • Create Tag
    • Delete Tag
    • Update Tag
    • List Tags
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ConversationDto
    • CreateTagDto
    • ChannelConversationDto
    • UpdateTagDto
    • TagDto
    • ConversationTimelineDto
    • PagedResultOfTagDto
    • AiSummaryDto
    • ReplyInfoDto
    • InternalThreadDto
    • LocationMessageDto
    • AssignationInfoDto
    • PagedResultOfConversationDto
    • PagedResultOfConversationTimelineDto
  1. Contact Properties

Create Contact Property

POST
/v1/contact-property-definitions

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 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": "Status3",
    "type": "Select",
    "isRequired": false,
    "selectOptions": [
      { "value": "Lead", "color": "#FF5733" },
      { "value": "Customer", "color": "#33FF57" },
      { "value": "VIP", "color": null }
    ]
  }'
Response Response Example
{
    "workspaceId": "string",
    "name": "string",
    "key": "string",
    "type": 0,
    "isRequired": true,
    "selectOptions": [
        "string"
    ],
    "lastModificationTime": null,
    "lastModifierId": null,
    "creationTime": "string",
    "creatorId": "string",
    "id": "string"
}
Modified at 2026-02-11 22:54:47
Previous
Update Contact Property
Next
Contact Properties Statistics
Built with