Skip to content
Dixa API/
/
Add members

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

List teams

Request

Lists all teams in an organization.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of teams in an organization

Bodyapplication/json
dataArray of objects(Team)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Create team

Request

Create a team.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The team name

namestringrequired
curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Team A"
  }'

Responses

The created team

Bodyapplication/json
dataobject(Team)required
data.​idstringrequired
data.​namestringrequired
Response
application/json
{
  "data": {
    "id": "005e7108-c85c-41d1-a945-4a8dc58c4399",
    "name": "Team A"
  }
}

List members

Request

Lists all agents/admins in a team.

Security
ApiKeyAuth
Path
teamIdstring(uuid)required

The team id

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams/{teamId}/agents' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of agents/admins in the specified team

Bodyapplication/json
dataArray of objects(TeamMember)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Remove members

Request

Remove agents/admins from a team.

Security
ApiKeyAuth
Path
teamIdstring(uuid)required

The team id

Bodyapplication/jsonrequired

List of agent/admin ids to remove from the specified team

agentIdsArray of strings(uuid)
curl -i -X DELETE \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams/{teamId}/agents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentIds": [
      "a8080cf3-9d55-41dd-a8ef-b02414399e7a",
      "d53dbec1-e79c-4736-b9a1-15f6dce71ed4"
    ]
  }'

Responses

The agents/admins were successfully removed from the team

Response
No content

Add members

Request

Add agents/admins to a team.

Security
ApiKeyAuth
Path
teamIdstring(uuid)required

The team id

Bodyapplication/jsonrequired

List of agent/admin ids to add to the specified team

agentIdsArray of strings(uuid)
curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams/{teamId}/agents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentIds": [
      "912d5148-6918-4420-b23a-8584b896c8ae",
      "a8080cf3-9d55-41dd-a8ef-b02414399e7a"
    ]
  }'

Responses

Response
No content

List presence

Request

List the presence status of all agents/admins in a team.

Security
ApiKeyAuth
Path
teamIdstring(uuid)required

The team id

Query
pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams/{teamId}/presence?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of agents/admins presence status in the specified team

Bodyapplication/json
dataArray of objects(UserPresence)
metaobject(PaginationLinks)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Get team

Request

Get a team by id.

Security
ApiKeyAuth
Path
teamIdstring(uuid)required

The team id

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams/{teamId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The team

Bodyapplication/json
dataobject(Team)required
data.​idstringrequired
data.​namestringrequired
Response
application/json
{
  "data": {
    "id": "005e7108-c85c-41d1-a945-4a8dc58c4399",
    "name": "Team A"
  }
}

Delete team

Request

Delete a team.

Security
ApiKeyAuth
Path
teamIdstring(uuid)required

The team id

curl -i -X DELETE \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/teams/{teamId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The team was successfully deleted

Response
No content

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations