Contacts

Create Contact

Create a new Contact

post/v1/workspaces/{workspace_id}/contacts

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/contacts
  • Auth: API key in header api_access_token

Path parameters

workspace_idinteger required

The numeric ID of the workspace

Request body

inbox_idnumber required

ID of the inbox to which the contact belongs

namestring

name of the contact

emailstring

email of the contact

blockedboolean

whether the contact is blocked or not

phone_numberstring

phone number of the contact

avatarstring binary

Send the form data with the avatar image binary or use the avatar_url

avatar_urlstring

The url to a jpeg, png file for the contact avatar

identifierstring

A unique identifier for the contact in external system

additional_attributesobject

An object where you can store additional attributes for contact. example {"type":"customer", "age":30}

custom_attributesobject

An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.

Example request

{
  "inbox_id": 1,
  "name": "Alice",
  "email": "alice@acme.inc",
  "phone_number": "+123456789",
  "avatar_url": "https://example.com/avatar.png",
  "identifier": "1234567890",
  "additional_attributes": {
    "type": "customer",
    "age": 30
  },
  "custom_attributes": {}
}

Response

Success

idnumber

Id of the user

availability_status'online' | 'offline'

Availability status of the user

Example response

{
  "payload": [
    {
      "custom_attributes": {
        "attribute_key": "attribute_value",
        "signed_up_at": "dd/mm/yyyy"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.