Skip to content
Dixa API/
/
Anonymize entity

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

Anonymize end user

Request

Request the anonymization of an end user.

Security
ApiKeyAuth
Path
userIdstring(uuid)required

The id of the end user to anonymize

Query
forceboolean

Whether to force close all the conversations initiated by the end user, if any are found in a non closed state.

Default false
curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/endusers/{userId}/anonymize?force=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The end user's anonymization request status

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{
  "data": {
    "id": "6bf55369-a670-4e6b-9f70-ecdb9913549f",
    "entityType": "UserAnonymizationType",
    "_type": "User",
    "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "targetEntityId": "f28fafd6-2e42-4441-943c-388a8e0ef433",
    "requestedBy": "2b01e4c9-0c3a-47d4-9462-cd5a1a4687f5"
  }
}

Anonymize conversation

Request

Request the anonymization of a conversation.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required

the id of the conversation to anonymize

Query
forceboolean

Whether to force close the conversation if it is found in a non closed state.

Default false
curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/anonymize?force=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The conversation's anonymization request status

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{
  "data": {
    "id": "87bac308-e49f-4134-84cc-96b868f1e1e4",
    "entityType": "ConversationAnonymizationType",
    "_type": "Conversation",
    "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "targetEntityId": "10749",
    "requestedBy": "b165fdaa-51d6-44b0-bfcd-5f431d623fa7"
  }
}

Anonymize message

Request

Request the anonymization of a single message in a conversation.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required

the id of the conversation in which the message belongs

messageIdstring(uuid)required

the id of the message to anonymize

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/messages/{messageId}/anonymize' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The message's anonymization request status

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{
  "data": {
    "id": "b165fdaa-51d6-44b0-bfcd-5f431d623fa7",
    "entityType": "MessageAnonymizationType",
    "_type": "Message",
    "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "targetEntityId": "10749_1b9adc49-62f7-4056-a9c0-c18c1f25afdb",
    "requestedBy": "4c7af391-b7fd-4560-9d82-b3464eef8776"
  }
}

Get anonymization status

Request

Retrieve an anonymization request submitted earlier (user or conversation).

Security
ApiKeyAuth
Path
requestIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/anonymization/request/{requestId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The anonymization request

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{
  "data": {
    "id": "062f0b37-4de0-40f2-95a4-641435cb2869",
    "entityType": "UserAnonymizationType",
    "_type": "User",
    "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "targetEntityId": "da9db703-4a7a-4f44-8a6a-c03b179b8ae2",
    "requestedBy": "bac5a02c-15b3-44da-ae1e-ab7b9db4aa89"
  }
}

Anonymize entityDeprecated

Request

Anonymize the requested entity (user or conversation). For a conversation to be successfully anonymized, it should be in the status closed. Otherwise, it requires forceAnonymization parameter set to true in the input body. NOTE: This endpoint is deprecated. Prefer using the anonymization endpoints of specific resources instead.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

A request to anonymize an entity in the system (user or conversation).

entityIdstringrequired
forceAnonymizationboolean
_typestring

values: [Conversation, Message, User]

entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecated

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/anonymization \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityId": "a53b25da-f676-4c52-acac-58c9280aa23d",
    "_type": "User"
  }'

Responses

The anonymization request status

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{
  "data": {
    "id": "a53b25da-f676-4c52-acac-58c9280aa23d",
    "entityType": "UserAnonymizationType",
    "_type": "User",
    "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "targetEntityId": "6292b720-9dbd-4ff7-8942-f4e917cc1520",
    "requestedBy": "062f0b37-4de0-40f2-95a4-641435cb2869"
  }
}

Custom Attributes

Operations

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