1. Contact
Hatif
  • Rate Limiting
  • Account API
    • Service Login
      POST
  • Channels API
    • Get Channels
      GET
  • Support API
    • Upload Image, Video, or PDF
      POST
    • Upload Audio File
      POST
  • Whatsapp API
    • Send Text
      POST
    • Send Template
      POST
    • Send Image
      POST
    • Send Audio
      POST
    • Send Video
      POST
    • Send File
      POST
    • Send Interactive Buttons
      POST
    • List Templates (Service Account)
      GET
  • Contact
    • Set Property Value on Contact
      PUT
    • Search Contacts
      POST
    • Delete Property Value on Contact
      DELETE
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contacts
      GET
    • Get Contact By Id
      GET
    • Create Bulk Contacts vCards
      POST
    • Contacts History
      GET
  • Contact Properties
    • List Contact Properties
      GET
    • Contact Properties Statistics
      POST
    • Create Contact Property
      POST
    • Update Contact Property
      PUT
    • Delete Contact Property
      DELETE
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
    • List Conversations
    • Create Conversation
    • Assign Conversation
    • Get Conversation
    • Assign Conversation
  • Tags API
    • Tag a conversation
    • Create Tag
    • Delete Tag
    • Update Tag
    • List Tags
  • Outbound IVR
    • Create Outbound IVR
    • Get Outbound IVR Request
  • Outbound IVR Flows
    • Create Outbound IVR Flow
    • List Outbound IVR Flows
    • Get Outbound IVR Flow
    • Update Outbound IVR Flow
    • Delete Outbound IVR Flow
  • Tasks API
    • Create Task
    • List Tasks
    • Get Task
    • Update Task
    • Delete Task
    • List Task Properties
    • Create Task Property
    • List Task Projects
    • Create Task Project
    • Get Task Project
    • Rename Task Project
    • Delete Task Project
    • List Task Sections
    • Create Task Section
    • List Tasks By Conversation
    • Move Task
    • Schedule Task
    • Assign Task
    • Set Task Due Date
    • Complete Task
    • Reopen Task
    • Set Task Section
    • Move Task Project
    • Rename Task Section
    • Delete Task Section
    • Move Task Section
    • Update Task Property
    • Delete Task Property
    • Set Task Property Value
    • List Task Comments
    • Create Task Comment
    • Edit Task Comment
    • Delete Task Comment
    • Set Task Reminder
  • Teams API
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Add Team Members
    • Update Team Member Conversation Access
    • Remove Team Member
    • List Teams
    • List Team Member Options
    • List Team Assignment Targets
    • Assign Conversation to Team
  • Partner API
    • 2. Register customer
      • 1) Create registration
      • Update registration details
      • Resend mobile code
      • 2) Verify mobile code
      • 3) Send email code
      • 4) Verify email code
      • 5) Complete registration → workspace + workspace key
      • Issue another workspace key
    • 3. Subscribe (plan & balance)
      • Add wallet balance (top-up) → payment link
      • Plans you can sell (find the Builder plan ID)
      • Get wallet balance
      • Create quote (plan) → payment link
      • Get quote status (poll for payment)
    • 4. Phone number
      • Assign number (after payment)
      • Available numbers
      • List the workspace's channels
    • 5. Contract
      • Replaced: use Get activation link
      • Replaced: number status is on the channel
      • Get activation link
    • 6. AI agent (SIP)
      • Connect the number to your AI agent
      • Disconnect your AI agent
    • 7. Calls & events
      • Not available yet: list calls
      • Not available yet: set events webhook
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ServiceAccountTemplateDto
    • OutboundIvrOption
    • ConversationDto
    • RegistrationDetails
    • CreateTagDto
    • AbpError
    • ServiceAccountTemplateParameterDto
    • OutboundIvrQuestionStepProps
    • ChannelConversationDto
    • UpdateTagDto
    • TaskPropertyValue
    • CreateRegistration
    • ServiceAccountCreateTaskDto
    • TemplateParameterDto
    • OutboundIvrStep
    • OtpCode
    • TagDto
    • PagedResultOfTagDto
    • TaskActivityPropertySnapshot
    • ConversationTimelineDto
    • ApiCredential
    • ParameterValueDto
    • CreateOutboundIvrRequest
    • TaskActivitySnapshot
    • SaveOutboundIvrFlow
    • ChannelNotFoundError
    • OutboundIvrFlow
    • Quote
    • AiSummaryDto
    • TaskActivityDto
    • ReplyInfoDto
    • OutboundIvrAnswer
    • TaskSummaryDto
    • InternalThreadDto
    • OutboundIvrStatus
    • TaskDto
    • LocationMessageDto
    • OutboundIvrResult
    • PagedResultOfTaskDto
    • AssignationInfoDto
    • TaskPropertyDefinitionDto
    • PagedResultOfConversationDto
    • OutboundIvrAudioType
    • OutboundIvrRequest
    • PagedResultOfConversationTimelineDto
    • TaskProjectDto
    • TaskSectionDto
    • OutboundIvrWebhookPayload
    • PagedResultOfTaskProjectDto
    • PagedResultOfTaskSectionDto
    • UpdateTaskDto
    • MoveTaskDto
    • SetTaskSectionDto
    • SetTaskScheduleDto
    • AssignTaskDto
    • SetTaskDueDateDto
    • NameDto
    • MoveBeforeDto
    • TaskPropertyOptionDto
    • CreateTaskPropertyDto
    • UpdateTaskPropertyDto
    • TaskCommentDto
    • WriteTaskCommentDto
    • PagedResultOfTaskCommentDto
    • SetTaskReminderDto
  1. Contact

Set Property Value on Contact

PUT
/v1/contacts/{{contactId}}/properties/{{property_id}}
Sets (creates or updates) the value of a single custom property on a contact — e.g. setting a "Possible Client" or "VIP" custom field that's been defined for the workspace.
contactId and propertyId are supplied directly in the URL path (see the request above). propertyId identifies which custom field you're setting (e.g. "Loyalty Tier") — it is not a value-record ID.
ℹ️ To find the propertyId for a custom field, call List Contact Properties — each entry returned there includes the id you need here.
Behavior:
If a value already exists for this property on the contact, it's updated in place. If not, a new entry is added.
Sending value: null removes the property from the contact entirely — this endpoint doubles as an implicit clear/unset.
Every actual value change (old → new) is recorded to the contact's audit trail, visible via GET /v1/contacts/{contactId}/history. No-op changes (re-setting the same value) are not logged.
Returns the full updated contact.
Validation:
If the property is marked required and value is null → error: Property '{Name}' is required.
If the property type is Select, value must match one of the property's predefined selectOptions → otherwise: Invalid select option '...' for property '...'.
Text, Number, and Date types have no extra validation beyond the required check.
Property types:
TypeCodeValue shape
Text1string
Number2decimal
Select3must match one of the property's selectOptions
Date4DateTime

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff --request PUT 'https://api.voxa.sa/v1/contacts/{{contactId}}/properties/{{property_id}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'
Response Response Example
{
    "workspaceId": "d307b8...............",
    "name": "أحمد نصحي | هاتف",
    "phoneNumber": "+9665...........",
    "contactType": 1,
    "email": "noshy@hatif.io",
    "company": null,
    "position": null,
    "customFields": null,
    "notes": [],
    "customProperties": [
        {
            "propertyDefinitionId": "3a1d7c...............",
            "propertyName": "Loyalty Tier",
            "propertyType": 3,
            "textValue": null,
            "numberValue": null,
            "dateValue": null,
            "selectValue": "VIP"
        }
    ],
    "lastModificationTime": "2026-06-16T12:03:31.995983",
    "lastModifierId": null,
    "creationTime": "2025-04-23T19:24:17.465921",
    "creatorId": "3a1cd6...............",
    "id": "3a18a7..............."
}
Modified at 2026-06-19 13:36:04
Previous
List Templates (Service Account)
Next
Search Contacts
Built with