# Dixa integration

> Conversational customer service platform API for managing conversations, messages, end users (contacts), agents, teams, queues, tags, ratings, business hours, webhooks, and analytics.

- Authentication: apiKey

## Tools (119)

- **Activate tag**: Activate a tag.
- **Add internal note**: Create an internal note in a conversation by providing the conversation id.
- **Add internal notes**: Create internal notes in a conversation by providing the conversation id.
- **Add members**: Add agents/admins to a team.
- **Add message**: Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. <
- **Anonymize conversation**: Request the anonymization of a conversation.
- **Anonymize end user**: Request the anonymization of an end user.
- **Anonymize message**: Request the anonymization of a single message in a conversation.
- **Assign agents**: Assign one or more agents/admins to a given queue.
- **Bulk tag conversation**: Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created.
- **Check if a business is open**: Check if a business is open either right now or at the specified timestamp.
- **Claim conversation**: Claim a conversation for a given agent. To avoid taking over assigned conversations, set the `force` paremeter to false
- **Close conversation**: Mark a conversation as closed by providing its id.
- **Create agent**: Create an agent.
- **Create agents**: Create agents in bulk.
- **Create article**: Create a knowledge article
- **Create conversation**: Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field.
- **Create conversation rating offer**: Create a rating offer for a specific conversation.
- **Create conversation rating result**: Create a rating result for a specific conversation.
- **Create end user**: Create an end user.
- **Create end users**: Create multiple end users in a single bulk action
- **Create queue**: Create a queue.
- **Create tag**: Create a tag.
- **Create team**: Create a team.
- **Create Webhook Subscription**: Create a Webhook Subscription.
- **Deactivate tag**: Deactivate a tag.
- **Delete agent**: Downgrade an agent/admin to become an end user.
- **Delete article**: Delete a knowledge article
- **Delete article translation**: Delete all versions of a knowledge article translation
- **Delete tag**: Deletes the tag and all its associations. Note that this operation is irreversible.
- **Delete team**: Delete a team.
- **Delete template**: Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible.
- **Delete Webhook Subscription**: Delete a Webhook Subscription.
- **Filter values**: Get possible values to be used with a given filter attribute. Filter attributes are not metric or record specific, so one filter attribute can be used with multiple metrics/records. When a filter valu
- **Followup conversation**: Follow up a conversation by providing its id and expiration timestamp.
- **Get a business hours schedule definition.**: Get a business hours schedule definition in an organization by providing its ID.
- **Get agent**: Get an agent/admin by id.
- **Get anonymization status**: Retrieve an anonymization request submitted earlier (user or conversation).
- **Get article**: Get a knowledge article by id
- **Get article translations**: Get a knowledge article translations
- **Get category**: Get a knowledge category by id
- **Get category translations**: Get the knowledge category translations
- **Get collection**: Get a knowledge collection by id
- **Get collection catalog**: Get collection catalog, including all categories and articles
- **Get contact endpoint**: Get contact endpoint by id (email or phone number).
- **Get conversation**: Get a conversation by id.
- **Get custom attribute definition by id**: Get custom attribute in an organization by id.
- **Get end user**: Get an end user by id.
- **Get Metric Data**: Get data of a specific metric (aggregated)
- **Get Metric Records Data**: Get data of specific metric records (unaggregated)
- **Get organization details**: Retrieves information about the organization associated with the provided API token
- **Get presence**: Get the presence status for an agent/admin.
- **Get queue**: Get a queue by id.
- **Get queue availability**: Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging.
- **Get tag**: Get a tag by id.
- **Get team**: Get a team by id.
- **Get the position of the conversation in its current queue**: Get the approximate position of a given conversation in its current queue.
- **Get the upcoming business hours schedule.**: Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions.
- **Import conversation**: Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the m
- **Link a conversation to a parent conversation**: Links the specified conversation to a parent conversation with the specified link type. Limitations: * Maximum of 100 child conversations per parent * Only 1 parent per child conversation * A child co
- **List activity log**: Get the activity log for a conversation by providing the conversation id.
- **List agent presence**: List the presence status for all agents/admins in an organization.
- **List agents**: Lists all agents/admins in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.
- **List agent teams**: List the teams in which the agent/admin is a member.
- **List all Webhook Subscriptions**: List of all Webhook Subscriptions in an organization.
- **List business hours schedules**: List business hours schedules in an organization with pagination.
- **List collections**: Paginated list knowledge collections
- **List contact endpoints**: List all available contact endpoints in an organization.
- **List conversation tags**: Get the tags for a particular conversation by providing the conversation id.
- **List custom attributes definitions**: List all custom attributes in an organization.
- **List end user conversations**: Lists conversations requested by an end user. <br/> Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the [GET /conversati
- **List end users**: Lists all end users in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.<br/> <b>Note:</b>
- **List flows**: List all conversations flows in an organization.
- **List internal notes**: Get all internal notes for a particular conversation by providing the conversation id.
- **List linked conversations**: Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations.
- **List messages**: Get all messages for a particular conversation by providing the conversation id. Note that messages in `ContactForm` conversations can have attributes of `"_type": "EmailAttributes"` if they are creat
- **List organization activity log**: List all activity logs for an organization.
- **List queue members**: List all agents/admins that are members of a queue by providing the queue id.
- **List queues**: List all queues in an organization.
- **List ratings for a conversation**: Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the su
- **List tags**: List all tags in an organization. Only active tags are returned by default. To include deactivated tags use `?includeDeactivated=true`.
- **List team members**: Lists all agents/admins in a team.
- **List team presence**: List the presence status of all agents/admins in a team.
- **List teams**: Lists all teams in an organization.
- **List templates**: Lists all templates belonging to an organization.
- **Metric Description**: This endpoint lists all available properties of a metric to use for querying its data
- **Metric Record Description**: This endpoint lists all available properties of a record to use for querying its data
- **Metric Records Catalogue**: This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data
- **Metrics Catalogue**: This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data
- **Move article**: Move a knowledge article to a new parent
- **Patch agent**: Patch an agent/admin.
- **Patch agents**: Bulk patch agents/admins.
- **Patch conversation custom attributes**: Patch custom attributes of a conversation
- **Patch end user**: Patch an end user.
- **Patch end user custom attributes**: Patch custom attributes of an end user
- **Patch end users**: Bulk patch end users.
- **Publish article**: Publish a new version of all translations for a knowledge article
- **Publish translation**: Publish a specific translation for search
- **Remove agents**: Bulk remove agents/admins from the specified queue.
- **Remove article parent**: Remove a parent from a knowledge article
- **Remove members**: Remove agents/admins from a team.
- **Reopen conversation**: Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue.
- **Search conversations with filters**: Search for conversations containing a particular text or by filter or combine them both
- **Tag conversation**: Tag a conversation. You may only use active tags to tag conversations.
- **Transfer conversation**: Transfer a conversation to a target queue.
- **Unpublish article**: Remove all translations of a knowledge article from search
- **Unpublish translation**: Mark a specific translation as unpublished
- **Untag conversation**: Untag a conversation. You may remove active or inactive tags from a conversation.
- **Update agent**: Update an agent/admin.
- **Update agents**: Bulk update agents/admins.
- **Update article**: Update a knowledge article
- **Update article translations**: Update translations for a knowledge article. Supports partial success.
- **Update end user**: Update an end user.
- **Update end users**: Bulk update end users.
- **Updates the working channel of an agent**: Updates the working channel of an agent
- **Upload article attachments**: Upload one or more image files to be used as attachments in knowledge articles. Supported formats: image/png, image/jpeg, image/gif, image/webp. Maximum 5 files per request, 4 MB per file, with a tota
- **Webhook Subscription**: Get a Webhook Subscription by ID.
- **Webhook Subscription Event Logs**: Get the latest Webhook Subscription Event logs.
- **Webhook Subscription Last Delivery Statuses**: Get the latest delivery statuses of a Webhook Subscription.

## Related prompts

- [Sync everyone who contacts Dixa support into HubSpot](https://www.generalinput.com/prompts/sync-everyone-who-contacts-dixa-support-into-hubspot.md)
- [Turn tagged Dixa bug reports into clean Linear issues](https://www.generalinput.com/prompts/turn-tagged-dixa-bug-reports-into-clean-linear-issues.md)
- [Get Slack alerts for low Dixa customer satisfaction scores](https://www.generalinput.com/prompts/get-slack-alerts-for-low-dixa-customer-satisfaction-scores.md)
- [Start every workday with a support health digest in Slack](https://www.generalinput.com/prompts/start-every-workday-with-a-support-health-digest-in-slack.md)

Connect Dixa in General Input: https://www.generalinput.com/apps/dixa