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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Dixa

Dixa Conversations API

The Conversations API from Dixa — 27 operation(s) for conversations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 31 operations across 27 paths, and defines 251 schemas. It is described by OpenAPI 3.0.3, at version beta.

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

31 operations 27 paths 251 schemas 1 DELETE11 GET3 PATCH9 POST7 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 Conversations 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 31

Across 27 paths, the API surfaces 31 operations — 1 DELETE, 11 GET, 3 PATCH, 9 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Conversations 31
PATCH
/beta/conversations/{conversationId}/anonymize
Anonymize conversation
patchConversationsConversationidAnonymize 2 params → 202400404409500
PATCH
/beta/conversations/{conversationId}/messages/{messageId}/anonymize
Anonymize message
patchConversationsConversationidMessagesMessageidAnonymize 2 params → 202400404409500
PUT
/beta/conversations/{conversationId}/close
Close conversation
putConversationsConversationidClose 1 param body → 204400404
PUT
/beta/conversations/{conversationId}/followup
Followup conversation
putConversationsConversationidFollowup 1 param body → 204400404
PUT
/beta/conversations/{conversationId}/reopen
Reopen conversation
putConversationsConversationidReopen 1 param body → 204400404500
PUT
/beta/conversations/{conversationId}/transfer/queue
Transfer conversation
putConversationsConversationidTransferQueue 1 param body → 204400404500
POST
/beta/conversations/{conversationId}/notes/bulk
Add internal notes
postConversationsConversationidNotesBulk 1 param body → 200400404500
GET
/beta/conversations/{conversationId}/notes
List internal notes
getConversationsConversationidNotes 1 param → 200400404500
POST
/beta/conversations/{conversationId}/notes
Add internal note
postConversationsConversationidNotes 1 param body → 200400404500
POST
/beta/conversations/{conversationId}/ratings/{ratingId}/submit
Create conversation rating result
postConversationsConversationidRatingsRatingidSubmit 2 params body → 201400500
POST
/beta/conversations/{conversationId}/ratings/offer
Create conversation rating offer
postConversationsConversationidRatingsOffer 1 param body → 201400404500
GET
/beta/conversations/{conversationId}/ratingdeprecated
List rating
getConversationsConversationidRating 1 param → 200400404500
GET
/beta/conversations/{conversationId}/ratings
List ratings for a conversation
getConversationsConversationidRatings 1 param → 200400404500
GET
/beta/conversations/activitylog
List organization activity log
getConversationsActivitylog 4 params → 200400500
GET
/beta/conversations/flows
List flows
getConversationsFlows 1 param → 200400500
PUT
/beta/conversations/{conversationId}/tags/{tagId}
Tag conversation
putConversationsConversationidTagsTagid 2 params → 204400404500
DELETE
/beta/conversations/{conversationId}/tags/{tagId}
Untag conversation
deleteConversationsConversationidTagsTagid 2 params → 204400404500
POST
/beta/conversations/{conversationId}/tags/bulk
Bulk tag conversation
postConversationsConversationidTagsBulk 1 param body → 202400404500
GET
/beta/conversations/{conversationId}/tags
List tags
getConversationsConversationidTags 1 param → 200400404500
GET
/beta/conversations/{conversationId}/messages
List messages
getConversationsConversationidMessages 1 param → 200400404
POST
/beta/conversations/{conversationId}/messages
Add message
postConversationsConversationidMessages 1 param body → 200400404500
POST
/beta/conversations
Create conversation
postConversations body → 201400404500
POST
/beta/conversations/import
Import conversation
postConversationsImport body → 201400404500
PATCH
/beta/conversations/{conversationId}/custom-attributes
Patch conversation custom attributes
patchConversationsConversationidCustom-attributes 1 param body → 200400401404
PUT
/beta/conversations/{conversationId}/claim
Claim conversation
putConversationsConversationidClaim 1 param body → 204400404409
GET
/beta/conversations/{conversationId}/activitylog
List activity log
getConversationsConversationidActivitylog 1 param → 200400500
GET
/beta/conversations/{conversationId}
Get conversation
getConversationsConversationid 1 param → 200400404500
PUT
/beta/conversations/{conversationId}/link
Link a conversation to a parent conversation
putConversationsConversationidLink 1 param body → 204400404500
GET
/beta/conversations/{conversationId}/linked
List linked conversations
getConversationsConversationidLinked 1 param → 200400404500
GET
/beta/search/conversationsdeprecated
Search conversations
getSearchConversations 4 params → 200400401500
POST
/beta/search/conversations
Search conversations with filters
postSearchConversations 2 params body → 200400401500

Schemas 251

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

IsNotOneOf2
object
1 property
Closing
object
Triggers the closing of the conversation
2 properties 2 required
ActivityLogAttribute
Filters
object
2 properties 1 required
TagRemovedAttribute
object
1 property 1 required
SearchField
IsOneOf4
object
1 property 1 required
ConversationSubjectUpdatedAttribute
object
2 properties 2 required
Callback
object
4 properties 4 required
NoteAddedAttribute
object
2 properties 1 required
EmailContent
ChatAttributes
object
4 properties 1 required
ConversationRatedActivityType
object
TransferConversationInput
object
2 properties 1 required
QueueId
object
1 property 1 required
PatchConversationCustomAttributesOutput
object
1 property
UserAnonymizationType
object
BulkCreateNoteOutput
object
1 property
Map_Vector_String
object
Snippet of text where a match was found. Matched text will be wrapped in \ tags.
ListConversationRatingsOutput
object
1 property
SearchOutput
object
2 properties
ContactId
object
1 property 1 required
MessageAddedAttribute
object
3 properties 1 required
CustomAttributeOperator
TwitterConversation
object
15 properties 5 required
LinkConversationInput
object
2 properties 2 required
CreateMessageOutput
object
1 property 1 required
FollowupConversationInput
object
2 properties 1 required
ConversationAnonymizationType
object
ImportConversationOutput
object
1 property 1 required
GetConversationOutput
object
1 property 1 required
ConversationRatingCancelledActivityType
object
WhatsAppConversation
object
12 properties 4 required
SearchConversationsWithFiltersOutput
object
2 properties
ActivityLogEntry
object
7 properties 5 required
ConversationLink
ConversationLinkedAttribute
object
3 properties 3 required
ConversationRating
object
10 properties 6 required
Attachments
object
1 property
MessengerFormAttributes
object
3 properties 1 required
Regular
object
1 property 1 required
ConversationCreatedByAgentActivityType
object
ChannelOperator
Channel
object
1 property 1 required
Content
Checksum
object
2 properties 2 required
ConversationEndUserReplacedAttribute
object
2 properties 2 required
ConversationRatingNotOfferedAttribute
object
1 property
ConversationAssignedActivityType
object
Html
object
1 property 1 required
ContactForm
object
5 properties 4 required
Markdown
object
1 property 1 required
ListFlowsOutput
object
1 property
Assignment
object
2 properties 2 required
ListInternalNotesOutput
object
1 property
ConversationOfferTimeoutActivityType
object
Attributes
LastMessage
object
1 property 1 required
ConversationRatingScheduledActivityType
object
LongerThanOrEqualTo
object
In milliseconds; for example: '10800000' (3 hours)
1 property 1 required
Queue
object
2 properties 1 required
CreationDate
object
1 property 1 required
ReopenConversationInput
object
1 property
ConversationId
object
1 property 1 required
GenericAttributes
object
3 properties
ConversationSearchWithFiltersHit
object
2 properties 2 required
ActivityLogUser
object
4 properties 1 required
TagAddedActivityType
object
Duration
object
1 property 1 required
Chat
object
5 properties 3 required
CreateInternalNoteInput
object
3 properties 1 required
BulkCreateInternalNoteInput
object
1 property
IsOneOf3
object
1 property 1 required
FollowupAddedActivityType
object
BrowserInfo
object
4 properties 1 required
ConversationCreatedAttribute
object
1 property
ConversationTransferredAttribute
object
5 properties 3 required
SearchParametersInput
object
2 properties
ExcludesOne
object
1 property
CreateMessageOutputData
object
6 properties 2 required
RatingResult
object
5 properties 2 required
TransferFailedActivityType
object
Select
object
1 property
ErrorResponse
object
1 property 1 required
CallRecordingAttributes
object
2 properties 1 required
BadRequest
object
1 property 1 required
Conversation
ChatConversation
object
14 properties 4 required
ConversationRatingScheduledAttribute
object
1 property 1 required
ConversationPendingActivityType
object
ImportConversationResponse
object
2 properties 1 required
Email
object
5 properties 4 required
ConversationResponse
object
1 property 1 required
Between1
object
min and max in milliseconds; for example: '10800000' (3 hours)
2 properties 2 required
OutboundImport
object
6 properties 3 required
AssignedDate
object
1 property 1 required
EmailForward
object
1 property 1 required
Map_String
object
ConversationAssignedAttribute
object
2 properties 1 required
ConversationReservedAttribute
object
5 properties 5 required
IsNotOneOf4
object
1 property 1 required
PstnPhoneConversation
object
12 properties 4 required
TwitterAttributes
object
3 properties
Map_UUID_Option_AttributeValue
object
Condition
object
1 property 1 required
CreateRatingOfferInput
object
4 properties 1 required
Since
object
Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
1 property 1 required
ExcludesAll
object
1 property
Sms
object
3 properties 3 required
IsOneOf
object
1 property
RatingOffer
object
5 properties 4 required
ListActivityLogOutput
object
2 properties
ClaimConversationInput
object
2 properties 1 required
Unauthorized
object
1 property 1 required
BulkActionSuccess_ErrorResponse_InternalNoteData
object
1 property 1 required
DeprecatedActivityLogType
Replaced by type field
EmailContact
object
2 properties 1 required
UnknownAnonymizationType
object
FieldCanHaveMultipleValuesOrBeEmptyOperator
IncludesOne
object
1 property
IsOneOf1
object
1 property 1 required
ConversationClaimedAttribute
object
2 properties
InboundImport
object
5 properties 2 required
TagId
object
1 property 1 required
CreateRatingResultInput
object
4 properties 1 required
DirectionOperator
IsNotOneOf3
object
1 property 1 required
MessageAnonymizationType
object
AnonymizedConversation
object
11 properties 5 required
TranscriptAttributes
object
4 properties
IsNotOneOf
object
1 property
FieldHasSingleValueOperator
BulkActionOutcome_ErrorResponse_InternalNoteData
Between
object
Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
2 properties 2 required
MessageRedactedAttribute
object
3 properties 3 required
Map_AttributeValue
object
ConversationUnassignedActivityType
object
ConversationClosedActivityType
object
Tag
object
4 properties 3 required
IncludesAll
object
1 property
ContactFormAttributes
object
12 properties 1 required
BulkActionFailure_ErrorResponse_InternalNoteData
object
1 property 1 required
EmailAttributes
object
11 properties 2 required
IsNotEmpty
object
ConversationOfferAcceptedActivityType
object
Outbound
object
7 properties 1 required
Status1
object
1 property 1 required
TagRemovedActivityType
object
ConversationAutoReplySentAttribute
object
1 property 1 required
TagConversationInput
object
1 property 1 required
Text
object
1 property 1 required
FacebookMessengerAttributes
object
3 properties
ConversationReopenedActivityType
object
ConversationEndUserReplacedActivityType
object
SideConversation
object
1 property 1 required
PartialError
object
1 property 1 required
CreateConversationInput
AgentId
object
1 property 1 required
StatusOperator
SmsConversation
object
14 properties 4 required
ConversationRatingOfferedAttribute
object
2 properties 2 required
Message
object
5 properties 4 required
TimestampOperator
ConversationLanguageUpdatedAttribute
object
1 property 1 required
ThumbsUpOrDown
object
1 property 1 required
ConversationCreatedByCustomerActivityType
object
Conflict
object
1 property 1 required
LastActivity
object
1 property 1 required
Map_FormAttributeValue
object
FacebookMessengerConversation
object
12 properties 4 required
GenericConversationImport
object
10 properties 4 required
IsOneOf2
object
1 property
SmsAttributes
object
3 properties
FileMeta
object
5 properties 5 required
SubmittedRatingResult
ConversationRatingUnscheduledActivityType
object
ConversationTagsOutput
object
1 property
MessageAddedByCustomerActivityType
object
ConversationOfferRejectedActivityType
object
MimeType
ConversationUnassignedAttribute
object
1 property 1 required
ClosedDate
object
1 property 1 required
ImportMessageInput
CustomAttribute1
object
2 properties 2 required
FollowUp
object
1 property 1 required
ListLinkedConversationsOutput
object
1 property
CreateRatingOfferOutput
object
1 property 1 required
FormAttributeValue
MessengerConversation
object
14 properties 4 required
IsEmpty
object
DeprecatedAnonymizationType
Replaced by type field
WhatsAppAttributes
object
3 properties
CloseConversationInput
object
1 property
ConversationLanguageUpdatedActivityType
object
FollowupExpiredActivityType
object
ConversationFlow
object
4 properties 4 required
NotFound
object
1 property 1 required
TagAddedAttribute
object
1 property 1 required
Inbound
object
4 properties 1 required
ConversationOfferedAttribute
object
2 properties
ConversationAutoreplySentActivityType
object
CreateConversationOutput
object
1 property 1 required
TransferInitiatedActivityType
object
TransferSuccessfulActivityType
object
ConversationRatingOfferedActivityType
object
InternalNoteData
object
5 properties 5 required
AnonymizeEntityOutput
object
1 property 1 required
Query
object
2 properties 1 required
NoteAddedActivityType
object
EmailConversation
object
17 properties 7 required
CreateMessageInput
Only Outbound messages are supported for Sms and Whatsapp.
PaginationLinks
object
2 properties
ServerError
object
1 property 1 required
UnknownActivityType
object
ConversationCustomAttributesUpdatedAttribute
object
2 properties 1 required
CreateNoteOutput
object
1 property 1 required
ShorterThanOrEqualTo
object
In milliseconds; for example: '10800000' (3 hours)
1 property 1 required
GenericConversation
object
14 properties 4 required
MessageAddedByAgentActivityType
object
CreateRatingResultOutput
object
1 property 1 required
ConversationResolvedStateToggledAttribute
object
1 property 1 required
Nps
object
1 property 1 required
ConversationChannelChangedAttribute
object
1 property 1 required
ListMessagesOutput
object
1 property
ConversationTranscriptionStartedActivityType
object
ConversationSearchInnerHit
object
2 properties 2 required
IsNotOneOf1
object
1 property 1 required
AnonymizationRequestStatus
object
7 properties 6 required
FollowupRemovedActivityType
object
ConversationClaimedActivityType
object
File
object
2 properties 1 required
Direction
object
1 property 1 required
ConversationRatedAttribute
object
3 properties
BulkTagConversationInput
object
1 property
FormSubmission
object
1 property 1 required
FieldCanHaveSingleValueOrBeEmptyOperator
ConversationOfferedActivityType
object
PhoneAttributes
object
4 properties 2 required
CustomAttribute
object
4 properties 4 required
ContactFormConversation
object
17 properties 5 required
MimeTypeImpl
object
2 properties 2 required
DurationOperator
Until
object
Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
1 property 1 required
ConversationSearchHit
object
3 properties 2 required
ConversationReservedType
object
TooLarge
object
1 property 1 required
Text1
object
1 property 1 required
Csat
object
1 property 1 required
ConversationTranscriptionEndedActivityType
object
GetActivityLogOutput
object
1 property
ConversationTranscriptionEndedAttribute
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dixa-conversations-api-openapi.yml Raw ↑

Other APIs Dixa publishes across the network.

Dixa Agents API
AE Profile APIs.io
Dixa Analytics API
AE Profile APIs.io
Dixa Anonymization API
AE Profile APIs.io
Dixa Business Hours API
AE Profile APIs.io
Dixa Chatbots API
AE Profile APIs.io
Dixa Contact Endpoints API
AE Profile APIs.io
Dixa Custom Attributes API
AE Profile APIs.io
Dixa End Users API
AE Profile APIs.io
Dixa Internal Notes API
AE Profile APIs.io
Dixa Knowledge API
AE Profile APIs.io
Dixa Messages API
AE Profile APIs.io
Dixa Organization API
AE Profile APIs.io
#Conversations
← Back to D APIs
API Details
ID
dixa:dixa-conversations-api
Base URL
https://dev.dixa.io/v1
Docs
https://docs.dixa.io/
Provider
Dixa
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=dixa-conversations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dixa-conversations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Dixa Conversations 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.