How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dixa End Users API

The End Users API from Dixa — 6 operation(s) for end users.

Dixa End Users API is one of 20 APIs that Dixa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include End Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 11 operations across 6 paths, and defines 64 schemas. It is described by OpenAPI 3.0.3, at version beta.

Requests are made against a single base URL, https://dev.dixa.io.

11 operations 6 paths 64 schemas 3 GET4 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
beta
Base URL
https://dev.dixa.io/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Dixa End Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 3 GET, 4 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

End Users 11
GET
/beta/endusers
List end users
getEndusers 5 params → 200400404500
PUT
/beta/endusers
Update end users
putEndusers body → 200400500
POST
/beta/endusers
Create end user
postEndusers body → 201400500
PATCH
/beta/endusers
Patch end users
patchEndusers body → 200400500
POST
/beta/endusers/bulk
Create end users
postEndusersBulk body → 201400500
GET
/beta/endusers/{userId}
Get end user
getEndusersUserid 1 param → 200400404500
PUT
/beta/endusers/{userId}
Update end user
putEndusersUserid 1 param body → 200400404500
PATCH
/beta/endusers/{userId}
Patch end user
patchEndusersUserid 1 param body → 200400404500
PATCH
/beta/endusers/{userId}/anonymize
Anonymize end user
patchEndusersUseridAnonymize 2 params → 202400404409500
PATCH
/beta/endusers/{userId}/custom-attributes
Patch end user custom attributes
patchEndusersUseridCustom-attributes 1 param body → 200400401404
GET
/beta/endusers/{userId}/conversations
List end user conversations
getEndusersUseridConversations 3 params → 200400404500

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are EmailConversation (17 properties), ContactFormConversation (17 properties), TwitterConversation (15 properties), GenericConversation (14 properties). Each schema is shown below with its type and property counts.

FollowUp
object
1 property 1 required
ListEndUserConversationsOutput
object
2 properties
Queue
object
2 properties 1 required
MessengerConversation
object
14 properties 4 required
DeprecatedAnonymizationType
Replaced by type field
BulkPatchEndUsersInput
object
1 property
Integrity
object
2 properties 2 required
PatchEndUserInput
object
10 properties
CreateEndUserInput
object
10 properties
BulkUpdateEndUsersInput
object
1 property
NotFound
object
1 property 1 required
Validation
object
2 properties 1 required
BrowserInfo
object
4 properties 1 required
BulkActionFailure_BulkError_EndUser
object
1 property 1 required
UserAnonymizationType
object
AnonymizeEntityOutput
object
1 property 1 required
ListEndUsersOutput
object
2 properties
EmailConversation
object
17 properties 7 required
ErrorResponse
object
1 property 1 required
ServerError
object
1 property 1 required
PaginationLinks
object
2 properties
BadRequest
object
1 property 1 required
Conversation
GetEndUserOutput
object
1 property 1 required
ChatConversation
object
14 properties 4 required
SideConversation
object
1 property 1 required
PatchEndUserOutput
object
1 property 1 required
BulkUpdateEndUserInput
object
11 properties 2 required
TwitterConversation
object
15 properties 5 required
Infrastructure
object
2 properties 2 required
ConversationAnonymizationType
object
SmsConversation
object
14 properties 4 required
GenericConversation
object
14 properties 4 required
CreateEndUsersOutput
object
1 property
EmailForward
object
1 property 1 required
PatchEndUserCustomAttributesOutput
object
1 property
Conflict
object
1 property 1 required
AnonymizationRequestStatus
object
7 properties 6 required
PstnPhoneConversation
object
12 properties 4 required
Map_UUID_Option_AttributeValue
object
BulkPatchEndUserInput
object
11 properties 1 required
InvalidArgument
object
1 property 1 required
BulkActionOutcome_BulkError_EndUser
WhatsAppConversation
object
12 properties 4 required
ConversationLink
FacebookMessengerConversation
object
12 properties 4 required
BulkActionSuccess_BulkError_EndUser
object
1 property 1 required
Unauthorized
object
1 property 1 required
UpdateEndUserInput
object
10 properties 1 required
UnknownAnonymizationType
object
CustomAttribute
object
4 properties 4 required
UpdateEndUserOutput
object
1 property 1 required
CreateEndUsersInput
object
1 property
BulkUpdateEndUsersOutput
object
1 property
BulkError
EndUser
object
13 properties 2 required
BulkPatchEndUsersOutput
object
1 property
MessageAnonymizationType
object
ContactFormConversation
object
17 properties 5 required
NotFound1
object
2 properties 2 required
Assignment
object
2 properties 2 required
AnonymizedConversation
object
11 properties 5 required
CreateEndUserOutput
object
1 property 1 required
EmptyPatchSet
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dixa-end-users-api-openapi.yml Raw ↑

Other APIs Dixa publishes across the network.

Dixa Agents API
Dixa Analytics API
Dixa Anonymization API
Dixa Business Hours API
Dixa Chatbots API
Dixa Contact Endpoints API
Dixa Conversations API
Dixa Custom Attributes API
Dixa Internal Notes API
Dixa Knowledge API
Dixa Messages API
Dixa Organization API
Where this information came from

This is an independent, third-party profile of Dixa End Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.