Skip to content
Dixa API/
/
Patch end user custom att...

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Patch end user custom attributes

Request

Patch custom attributes of an end user

Security
ApiKeyAuth
Path
userIdstring(uuid)required
Bodyapplication/jsonrequired

The custom attributes of an end user to be patched. This should map the custom attribute id to the desired attribute value. Format: Map[UUID, Option[AttributeValue].

property name*Array of strings or stringadditional property

AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text

One of:

AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/endusers/{userId}/custom-attributes' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "274e5a2c-be0d-42c0-b725-3dd533729f68": "abcdef",
    "befae0d9-9679-42b9-af76-e76f64e28429": [
      "example1",
      "example2"
    ]
  }'

Responses

The patched end user attributes

Bodyapplication/json
dataArray of objects(CustomAttribute)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Patch conversation custom attributes

Request

Patch custom attributes of a conversation

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/jsonrequired

The custom attributes of an conversation to be patched. This should map the custom attribute id to the desired attribute value. Format: Map[UUID, Option[AttributeValue].

property name*Array of strings or stringadditional property

AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text

One of:

AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/custom-attributes' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "2f5515b6-7e98-4f4d-9010-bfd2a27d4f35": "012345",
    "e14708a6-eed9-495c-9d88-c72331e9e247": [
      "str1",
      "str2"
    ]
  }'

Responses

The patched conversation attributes

Bodyapplication/json
dataArray of objects(CustomAttribute)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Get custom attribute definition by id

Request

Get custom attribute in an organization by id.

Security
ApiKeyAuth
Path
customAttributeIdstringrequired
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/custom-attributes/{customAttributeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The configured custom attribute

Bodyapplication/json
dataobject(CustomAttributeDefinition)required
data.​idstring(uuid)required
data.​entityTypestringrequired

values: [Contact, Conversation]

data.​identifierstringrequired
data.​labelstringrequired
data.​inputDefinitionSelect (object) or Text (object)(CustomAttributeInputDefinition)required
One of:
data.​inputDefinition.​optionsArray of objects(SelectOption)
data.​descriptionstring
data.​createdAtstring(date-time)required
data.​updatedAtstring(date-time)
data.​isRequiredbooleanrequired
data.​isArchivedbooleanrequired
data.​isDeactivatedbooleanrequired
Response
application/json
{
  "data": {
    "id": "db5f673b-1c40-41e7-b71f-caab342f0607",
    "entityType": "Conversation",
    "identifier": "contact_reason",
    "label": "Contact Reason",
    "inputDefinition": { … },
    "description": "Reason for contacting",
    "createdAt": "2023-01-05T06:42:31.532Z[GMT]",
    "isRequired": true,
    "isArchived": false,
    "isDeactivated": false
  }
}

List custom attributes definitions

Request

List all custom attributes in an organization.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/custom-attributes \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of configured custom attributes

Bodyapplication/json
dataArray of objects(CustomAttributeDefinition)
Response
application/json
{
  "data": [
    { … },
    { … },
    { … }
  ]
}

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations