Patch custom attributes of an end user
Dixa API//
- List custom attributes definitions
Patch end user custom attributes
Patch conversation custom attributes
Get custom attribute definition by id
List custom attributes de...
Dixa API (beta)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io
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].
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
- Mock serverhttps://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/endusers/{userId}/custom-attributes
- https://dev.dixa.io/beta/endusers/{userId}/custom-attributes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'Response
application/json
{ "data": [ { … }, { … } ] }
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].
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
- Mock serverhttps://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/custom-attributes
- https://dev.dixa.io/beta/conversations/{conversationId}/custom-attributes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'Response
application/json
{ "data": [ { … }, { … } ] }
- Mock serverhttps://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/custom-attributes/{customAttributeId}
- https://dev.dixa.io/beta/custom-attributes/{customAttributeId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/custom-attributes/{customAttributeId}' \
-H 'Authorization: YOUR_API_KEY_HERE'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 } }
- Mock serverhttps://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/custom-attributes
- https://dev.dixa.io/beta/custom-attributes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/custom-attributes \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "data": [ { … }, { … }, { … } ] }