Anonymization

Anonymize conversation

Request the anonymization of a conversation.

SecurityApiKeyAuth
Request
path Parameters
conversationId
required
integer <int64>

the id of the conversation to anonymize

query Parameters
force
boolean
Default: false

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

Responses
202

The conversation's anonymization request status

400

Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: query parameter force

404
409
500
patch/v1/conversations/{conversationId}/anonymize
Request samples
Response samples
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 end user

Request the anonymization of an end user.

SecurityApiKeyAuth
Request
path Parameters
userId
required
string <uuid>

The id of the end user to anonymize

query Parameters
force
boolean
Default: false

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

Responses
202

The end user's anonymization request status

400
404
409
500
patch/v1/endusers/{userId}/anonymize
Request samples
Response samples
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 entityDeprecated

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.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

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

_type
string

values: [Conversation, Message, User]

entityId
required
string
ConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object) (DeprecatedAnonymizationType)
Deprecated

Replaced by _type field

forceAnonymization
boolean
Responses
200

The anonymization request status

400

Invalid value extracted from request context, Invalid value for: body, The entityId doesn't match the expected format for the specified type, The entity type is missing

500

Internal failure during request processing

post/v1/anonymization
Request samples
application/json
{
  • "entityId": "a53b25da-f676-4c52-acac-58c9280aa23d",
  • "_type": "User"
}
Response samples
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"
    }
}

Anonymize message

Request the anonymization of a single message in a conversation.

SecurityApiKeyAuth
Request
path Parameters
conversationId
required
integer <int64>

the id of the conversation in which the message belongs

messageId
required
string <uuid>

the id of the message to anonymize

Responses
202

The message's anonymization request status

400

Invalid value for: path parameter conversationId, Invalid value for: path parameter messageId, Invalid value extracted from request context

404
409
500
patch/v1/conversations/{conversationId}/messages/{messageId}/anonymize
Request samples
Response samples
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

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

SecurityApiKeyAuth
Request
path Parameters
requestId
required
string <uuid>
Responses
200

The anonymization request

400

Invalid value for: path parameter requestId, Invalid value extracted from request context

401

The user who issued the access token used in the request is not authorized to perform the operation

404

An entity in this request could not be found

500

Internal failure during request processing

get/v1/anonymization/request/{requestId}
Request samples
Response samples
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"
    }
}