Dixa
    Nothing Found

Users

Create a userDeprecated

SecurityApiKeyAuth or BearerAuth
Request
Request Body schema: application/json
required

The user to create

email
string

The email address to be associated with the user. Must not be associated with any other users.

name
string
phone_number
string (PhoneNumberString)
Responses
200

The user was created

post/v1/users
Request samples
application/json
{
  • "name": "string",
  • "email": "string",
  • "phone_number": "string"
}
Response samples
application/json
{
  • "data": {
    • "id": "string",
    • "email": "string",
    • "name": "string",
    • "roles": [
      • "string"
      ],
    • "avatar_url": "string",
    • "phone_number": "string"
    },
  • "paging": {
    • "cursors": {
      • "after": "string",
      • "before": "string"
      },
    • "next_page": "string",
    • "prev_page": "string"
    }
}

Get anonymization request for specified idDeprecated

SecurityApiKeyAuth or BearerAuth
Request
path Parameters
requestId
required
string
Responses
200

Anonymization request

get/v1/anonymization_request/{requestId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "target_entity_id": "string",
    • "entity_type": "user",
    • "initiated_at": "string",
    • "requested_by": "string",
    • "processed_at": "string"
    }
}
Returns a list of conversations requested by a specific user.Deprecated
SecurityApiKeyAuth or BearerAuth 
Request 
path Parameters
userId
required
string
Id of the requester


 
query Parameters
limit
integer  <= 200 
Maximum number of items per page. With upper bound set to 200.


 
Responses 
200
A JSON array of conversations


get/v1/users/{userId}/requested_conversations
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 0,
      • "created_at": "2015-11-30T00:00:00:000Z",
      • "requester_id": "string",
      • "channel": "widget_chat",
      • "direction": "outbound",
      • "queued_at": "2015-11-30T00:00:00:000Z",
      • "queue_id": "string",
      • "status": "open",
      • "status_updated_at": "2015-11-30T00:00:00:000Z",
      • "attributes": { },
      • "assigned_to": "string",
      • "assigned_at": "2015-11-30T00:00:00:000Z"
      }
    ],
  • "paging": {
    • "cursors": {
      • "after": "string",
      • "before": "string"
      },
    • "next_page": "string",
    • "prev_page": "string"
    }
}
Returns a list of users.Deprecated
SecurityApiKeyAuth or BearerAuth 
Request 
query Parameters
email
string
email to search for


 
limit
integer  <= 200 
Maximum number of items per page. With upper bound set to 200.


 
phone_number
string
phone number to search for


 
Responses 
200
A JSON array of users


get/v1/users
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "email": "string",
      • "name": "string",
      • "roles": [
        • "string"
        ],
      • "avatar_url": "string",
      • "phone_number": "string"
      }
    ],
  • "paging": {
    • "cursors": {
      • "after": "string",
      • "before": "string"
      },
    • "next_page": "string",
    • "prev_page": "string"
    }
}
Schedule anonymization for specified entityDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
Request Body schema: application/json
required
Entity info to schedule anonymization


entity_id
required
string
Id of the entity


 
entity_type
required
string (AnonymizationType) 
A type of entity for anonymization.


 Enum: "conversation" "user"  
force_anonymization
boolean
If set to true, anonymizes entity regardless of the status of related conversations. Defaults to false


 
Responses 
200
Scheduled anonymization


post/v1/anonymization_request
Request samples 
application/json
{
  • "entity_id": "string",
  • "entity_type": "user",
  • "force_anonymization": true
}
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "target_entity_id": "string",
    • "entity_type": "user",
    • "initiated_at": "string",
    • "requested_by": "string",
    • "processed_at": "string"
    }
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2024