Agent Management

Last updated 5 months ago

Was this helpful?

List Agents

get

/workspaces/{workspaceId}/agents

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

sortBystring · enum

Sort by field specified

Options: createdAt, statusAssignedCount, assignedCount, name

namestring

Filter by agent name

emailstring

Filter by agent email

agentStatusesstring · enum[]

Filter by agent status

roleIdsstring · uuid[]

Filter by agent role ids

lastStatusActivitySincestring

To filter agents by their last status change since.

lastStatusActivityUptostring

To filter agents by their last status change activity time.

agentIdsstring · uuid[]

To find specific agents by their ids. If this is specified, other parameters are ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "statusBeforeOffline": "active",
      "name": "text",
      "overrideName": true,
      "workspaceId": "text",
      "bio": "text",
      "avatarUrl": "text",
      "tagCount": 1,
      "wrapUpTime": 1,
      "rootItemAssignedCount": 1,
      "lastAssignedAt": "2025-02-21T18:02:53.268Z",
      "lastSetToAwayAt": "2025-02-21T18:02:53.268Z",
      "workload": {
        "id": "text",
        "workload": {
          "messaging": 1,
          "email": 1
        },
        "rule": {
          "id": "text",
          "workspaceId": "text",
          "name": "text",
          "description": "text",
          "default": true,
          "createdAt": "text",
          "updatedAt": "text",
          "assignedAgentIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "capacity": {
            "messaging": 1,
            "email": 1
          }
        },
        "ruleId": "text",
        "updatedAt": "2025-02-21T18:02:53.268Z"
      },
      "createdAt": "2025-02-21T18:02:53.268Z",
      "updatedAt": "2025-02-21T18:02:53.268Z",
      "availability": {
        "status": "active",
        "activity": "available",
        "activityTtl": 1,
        "activityText": "text",
        "lastStatusSet": "text",
        "lastActivitySet": "text",
        "updatedAt": "2025-02-21T18:02:53.268Z"
      },
      "timezone": "text",
      "defaultCountryCode": "text",
      "defaultCallerId": "text",
      "forwardNumber": {
        "enabled": true,
        "number": "text",
        "maskCaller": true
      },
      "transcriptionLocale": "ar-AE",
      "weeklySchedule": {
        "monday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "tuesday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "wednesday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "thursday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "friday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "saturday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "sunday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        }
      },
      "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
      "outOfOfficeResponse": "text",
      "type": "user",
      "userEmails": [
        "text"
      ],
      "roles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "holidays": [
        {
          "name": "text",
          "day": 1,
          "month": 1
        }
      ],
      "assignedSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "avatarUrl": "text",
        "defaultEmail": "text",
        "phoneNumber": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "teams": [
        {
          "id": "text",
          "name": "text",
          "memberSince": "2025-02-21T18:02:53.268Z",
          "activeMemberCount": 1,
          "pendingMemberCount": 1
        }
      ],
      "dropVms": [
        null
      ]
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Create Agent

Create a new agent with specified details like name, role, and basic bio.

post

/workspaces/{workspaceId}/agents

Authorizations

Path parameters

workspaceIdstringrequired

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/agents' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"type":"user","userId":"123e4567-e89b-12d3-a456-426614174000","weeklySchedule":{"monday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"tuesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"wednesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"thursday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"friday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"saturday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"sunday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}}},"teamIds":[null],"holidays":[{"name":"text","day":1,"month":1}]}'

201

404

409

422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "bio": "text",
  "avatarUrl": "text",
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-02-21T18:02:53.268Z",
  "lastSetToAwayAt": "2025-02-21T18:02:53.268Z",
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "createdAt": "text",
      "updatedAt": "text",
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "capacity": {
        "messaging": 1,
        "email": 1
      }
    },
    "ruleId": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "createdAt": "2025-02-21T18:02:53.268Z",
  "updatedAt": "2025-02-21T18:02:53.268Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-02-21T18:02:53.268Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "dropVms": [
    null
  ]
}

Created

List All Agents

Lists all agents for a workspace returning only minimal fields for each agent.

get

/workspaces/{workspaceId}/all-agents

Authorizations

Path parameters

workspaceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/all-agents' \
  --header 'Authorization: Bearer jwt'

200

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "name": "text",
      "avatarUrl": "text",
      "createdAt": "2025-02-21T18:02:53.268Z"
    }
  ]
}

Get Agent

Retrieve information about a specific agent, including their name, bio, status.

get

/workspaces/{workspaceId}/agents/{agentId}

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents/{agentId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "bio": "text",
  "avatarUrl": "text",
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-02-21T18:02:53.268Z",
  "lastSetToAwayAt": "2025-02-21T18:02:53.268Z",
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "createdAt": "text",
      "updatedAt": "text",
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "capacity": {
        "messaging": 1,
        "email": 1
      }
    },
    "ruleId": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "createdAt": "2025-02-21T18:02:53.268Z",
  "updatedAt": "2025-02-21T18:02:53.268Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-02-21T18:02:53.268Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "dropVms": [
    null
  ]
}

Get url to upload profile avatar to

Retrieve the url and form data to post profile avatar directly.

get

/workspaces/{workspaceId}/agents/{agentId}/presigned-upload

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents/{agentId}/presigned-upload' \
  --header 'Authorization: Bearer jwt'

200

{
  "mediaUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "formData": {
    "policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
    "x-amz-date": "20151229T000000Z",
    "x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
  },
  "expectedFields": [
    "text"
  ]
}

Get url to upload audio files

Retrieve the url and form data to post audio files directly.

post

/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio' \
  --header 'Authorization: Bearer jwt'

200

{
  "mediaUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "formData": {
    "policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
    "x-amz-date": "20151229T000000Z",
    "x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
  },
  "expectedFields": [
    "text"
  ]
}

Get agent media download

Get media download from an agent

get

/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

fileIdstringrequired

Query parameters

redirectboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download' \
  --header 'Authorization: Bearer jwt'

200

302

400

404

No body

Return file location

Update Agent

Modify the details of a specific agent, such as their name, bio, status.

patch

/workspaces/{workspaceId}/agents/{agentId}

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Body

namestring · min: 1 · max: 50

biostring · max: 240

statusstring · enum

Options: active, away, out-of-office

avatarUrlstring

dropVmsobject[]

wrapUpTimeinteger · max: 900

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberobject

transcriptionLocalestring · enum

Options: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO

weeklyScheduleobject

defaultSenderIdstring · uuid

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000

holidaysobject[]

assignedSkillsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/agents/{agentId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"status":"active","dropVms":[],"forwardNumber":{},"transcriptionLocale":"ar-AE","weeklySchedule":{"monday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"tuesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"wednesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"thursday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"friday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"saturday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"sunday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}}},"holidays":[{"name":"text","day":1,"month":1}],"assignedSkills":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","valueType":"single","selectedValues":[{"id":"123e4567-e89b-12d3-a456-426614174000","value":"text","icon":"text"}]}]}'

200

404

422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "bio": "text",
  "avatarUrl": "text",
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-02-21T18:02:53.268Z",
  "lastSetToAwayAt": "2025-02-21T18:02:53.268Z",
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "createdAt": "text",
      "updatedAt": "text",
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "capacity": {
        "messaging": 1,
        "email": 1
      }
    },
    "ruleId": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "createdAt": "2025-02-21T18:02:53.268Z",
  "updatedAt": "2025-02-21T18:02:53.268Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-02-21T18:02:53.268Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "dropVms": [
    null
  ]
}

Updated

Delete Agent

Remove a specific agent from the system, permanently deleting their profile and associated data.

delete

/workspaces/{workspaceId}/agents/{agentId}

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/agents/{agentId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Deleted

Get Agent

Retrieve information about a specific agent, including their name, bio, status.

get

/workspaces/{workspaceId}/agents/me

Authorizations

Path parameters

workspaceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents/me' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "bio": "text",
  "avatarUrl": "text",
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-02-21T18:02:53.268Z",
  "lastSetToAwayAt": "2025-02-21T18:02:53.268Z",
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "createdAt": "text",
      "updatedAt": "text",
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "capacity": {
        "messaging": 1,
        "email": 1
      }
    },
    "ruleId": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "createdAt": "2025-02-21T18:02:53.268Z",
  "updatedAt": "2025-02-21T18:02:53.268Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-02-21T18:02:53.268Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "dropVms": [
    null
  ]
}

Update Agent

Modify the details of a specific agent, such as their name, bio, status.

patch

/workspaces/{workspaceId}/agents/me

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 50

biostring · max: 240

statusstring · enum

Options: active, away, out-of-office

avatarUrlstring

dropVmsobject[]

wrapUpTimeinteger · max: 900

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberobject

transcriptionLocalestring · enum

weeklyScheduleobject

defaultSenderIdstring · uuid

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000

holidaysobject[]

assignedSkillsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/agents/me' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"status":"active","dropVms":[],"forwardNumber":{},"transcriptionLocale":"ar-AE","weeklySchedule":{"monday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"tuesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"wednesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"thursday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"friday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"saturday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"sunday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}}},"holidays":[{"name":"text","day":1,"month":1}],"assignedSkills":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","valueType":"single","selectedValues":[{"id":"123e4567-e89b-12d3-a456-426614174000","value":"text","icon":"text"}]}]}'

200

404

422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "bio": "text",
  "avatarUrl": "text",
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-02-21T18:02:53.268Z",
  "lastSetToAwayAt": "2025-02-21T18:02:53.268Z",
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "createdAt": "text",
      "updatedAt": "text",
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "capacity": {
        "messaging": 1,
        "email": 1
      }
    },
    "ruleId": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "createdAt": "2025-02-21T18:02:53.268Z",
  "updatedAt": "2025-02-21T18:02:53.268Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-02-21T18:02:53.268Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-02-21T18:02:53.268Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "dropVms": [
    null
  ]
}

Updated

Get Agent Availability

Retrieve information about availability of a specific agent.

get

/workspaces/{workspaceId}/agents/{agentId}/availability

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents/{agentId}/availability' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2025-02-21T18:02:53.268Z"
}

Update Agent Availability

Modify the availability of a specific agent.

patch

/workspaces/{workspaceId}/agents/{agentId}/availability

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Body

statusstring · enumrequired

Options: active, away, out-of-office

activitystring · enum

Options: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom

activityTtlinteger · min: 10 · max: 86400

activityTextstring · max: 48

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/agents/{agentId}/availability' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"status":"active","activity":"available"}'

200

404

422

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2025-02-21T18:02:53.268Z"
}

Updated

Get Agent Workload

Retrieve information about workload of a specific agent.

get

/workspaces/{workspaceId}/agents/{agentId}/workload

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/agents/{agentId}/workload' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "workload": {
    "messaging": 1,
    "email": 1
  },
  "rule": {
    "id": "text",
    "workspaceId": "text",
    "name": "text",
    "description": "text",
    "default": true,
    "createdAt": "text",
    "updatedAt": "text",
    "assignedAgentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "capacity": {
      "messaging": 1,
      "email": 1
    }
  },
  "ruleId": "text",
  "updatedAt": "2025-02-21T18:02:53.268Z"
}