Agent Management | Bird API Docs

No-code docs

List All Agents

get

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

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-03-28T19:00:12.068Z"
    }
  ]
}

Get Agent

get

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

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",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-03-28T19:00:12.068Z",
  "lastSetToAwayAt": "2025-03-28T19:00:12.068Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-03-28T19:00:12.068Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "createdAt": "2025-03-28T19:00:12.068Z",
  "updatedAt": "2025-03-28T19:00:12.068Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Get url to upload profile avatar to

get

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

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

post

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

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

Get media download from an agent

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

fileIdstringrequired

Query parameters

redirectbooleanoptional

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

Delete Agent

delete

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

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

get

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

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",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-03-28T19:00:12.068Z",
  "lastSetToAwayAt": "2025-03-28T19:00:12.068Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-03-28T19:00:12.068Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "createdAt": "2025-03-28T19:00:12.068Z",
  "updatedAt": "2025-03-28T19:00:12.068Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Get Agent Availability

get

Retrieve information about availability of a specific agent.

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-03-28T19:00:12.068Z"
}

Get Agent Workload

get

Retrieve information about workload of a specific agent.

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,
    "capacity": {
      "messaging": 1,
      "email": 1
    },
    "assignedAgentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "createdAt": "text",
    "updatedAt": "text"
  },
  "ruleId": "text",
  "updatedAt": "2025-03-28T19:00:12.068Z"
}

List Agents

get

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

sortBystring · enumoptional

Sort by field specified

Options: createdAt, statusAssignedCount, assignedCount, name

namestringoptional

Filter by agent name

emailstringoptional

Filter by agent email

agentStatusesstring · enum[]optional

Filter by agent status

roleIdsstring · uuid[]optional

Filter by agent role ids

lastStatusActivitySincestringoptional

To filter agents by their last status change since.

lastStatusActivityUptostringoptional

To filter agents by their last status change activity time.

agentIdsstring · uuid[]optional

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",
      "type": "user",
      "userEmails": [
        "text"
      ],
      "bio": "text",
      "avatarUrl": "text",
      "dropVms": [
        null
      ],
      "tagCount": 1,
      "wrapUpTime": 1,
      "rootItemAssignedCount": 1,
      "lastAssignedAt": "2025-03-28T19:00:12.068Z",
      "lastSetToAwayAt": "2025-03-28T19:00:12.068Z",
      "teams": [
        {
          "id": "text",
          "name": "text",
          "memberSince": "2025-03-28T19:00:12.068Z",
          "activeMemberCount": 1,
          "pendingMemberCount": 1
        }
      ],
      "workload": {
        "id": "text",
        "workload": {
          "messaging": 1,
          "email": 1
        },
        "rule": {
          "id": "text",
          "workspaceId": "text",
          "name": "text",
          "description": "text",
          "default": true,
          "capacity": {
            "messaging": 1,
            "email": 1
          },
          "assignedAgentIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "createdAt": "text",
          "updatedAt": "text"
        },
        "ruleId": "text",
        "updatedAt": "2025-03-28T19:00:12.068Z"
      },
      "createdAt": "2025-03-28T19:00:12.068Z",
      "updatedAt": "2025-03-28T19:00:12.068Z",
      "availability": {
        "status": "active",
        "activity": "available",
        "activityTtl": 1,
        "activityText": "text",
        "lastStatusSet": "text",
        "lastActivitySet": "text",
        "updatedAt": "2025-03-28T19:00:12.068Z"
      },
      "timezone": "text",
      "defaultCountryCode": "text",
      "defaultCallerId": "text",
      "forwardNumber": {
        "enabled": true,
        "number": "text",
        "maskCaller": true
      },
      "transcriptionLocale": "ar-AE",
      "roles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "avatarUrl": "text",
        "defaultEmail": "text",
        "phoneNumber": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "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"
            }
          ]
        }
      ],
      "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
      "outOfOfficeResponse": "text"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Create Agent

post

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

Authorizations

Path parameters

workspaceIdstringrequired

Body

one ofoptional

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 '{
    "name": "text",
    "bio": "text",
    "type": "user",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "teamId": "123e4567-e89b-12d3-a456-426614174000",
    "teamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "timezone": "text",
    "defaultCountryCode": "text",
    "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
      }
    ]
  }'

201

404

409

422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-03-28T19:00:12.068Z",
  "lastSetToAwayAt": "2025-03-28T19:00:12.068Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-03-28T19:00:12.068Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "createdAt": "2025-03-28T19:00:12.068Z",
  "updatedAt": "2025-03-28T19:00:12.068Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Created

Update Agent

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Body

namestring · min: 1 · max: 50optional

biostring · max: 240optional

statusstring · enumoptional

Options: active, away, out-of-office

avatarUrlstringoptional

dropVmsone of[] · max: 3optional

wrapUpTimeinteger · max: 900optional

timezonestringoptional

defaultCountryCodestringoptional

defaultCallerIdstringoptional

forwardNumberobjectoptional

transcriptionLocalestring · enumoptional

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

weeklyScheduleobjectoptional

holidaysobject[]optional

assignedSkillsobject[]optional

AgentAssignedSkill is a denormalized AgentSkill, and a part of Agent entity.

defaultSenderIdstring · uuidoptional

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

outOfOfficeResponsestring · max: 1000optional

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 '{
    "name": "text",
    "bio": "text",
    "status": "active",
    "avatarUrl": "text",
    "dropVms": [
      null
    ],
    "wrapUpTime": 1,
    "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
        }
      }
    },
    "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"
          }
        ]
      }
    ],
    "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
    "outOfOfficeResponse": "text"
  }'

200

404

422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-03-28T19:00:12.068Z",
  "lastSetToAwayAt": "2025-03-28T19:00:12.068Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-03-28T19:00:12.068Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "createdAt": "2025-03-28T19:00:12.068Z",
  "updatedAt": "2025-03-28T19:00:12.068Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Updated

Update Agent

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 50optional

biostring · max: 240optional

statusstring · enumoptional

Options: active, away, out-of-office

avatarUrlstringoptional

dropVmsone of[] · max: 3optional

wrapUpTimeinteger · max: 900optional

timezonestringoptional

defaultCountryCodestringoptional

defaultCallerIdstringoptional

forwardNumberobjectoptional

transcriptionLocalestring · enumoptional

weeklyScheduleobjectoptional

holidaysobject[]optional

assignedSkillsobject[]optional

AgentAssignedSkill is a denormalized AgentSkill, and a part of Agent entity.

defaultSenderIdstring · uuidoptional

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

outOfOfficeResponsestring · max: 1000optional

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 '{
    "name": "text",
    "bio": "text",
    "status": "active",
    "avatarUrl": "text",
    "dropVms": [
      null
    ],
    "wrapUpTime": 1,
    "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
        }
      }
    },
    "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"
          }
        ]
      }
    ],
    "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
    "outOfOfficeResponse": "text"
  }'

200

404

422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "rootItemAssignedCount": 1,
  "lastAssignedAt": "2025-03-28T19:00:12.068Z",
  "lastSetToAwayAt": "2025-03-28T19:00:12.068Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-03-28T19:00:12.068Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "createdAt": "2025-03-28T19:00:12.068Z",
  "updatedAt": "2025-03-28T19:00:12.068Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-03-28T19:00:12.068Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Updated

Update Agent Availability

patch

Modify the availability of a specific agent.

Authorizations

Path parameters

workspaceIdstringrequired

agentIdstringrequired

Body

statusstring · enumrequired

Options: active, away, out-of-office

activitystring · enumoptional

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

activityTtlinteger · min: 10 · max: 86400optional

activityTextstring · max: 48optional

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",
    "activityTtl": 1,
    "activityText": "text"
  }'

200

404

422

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2025-03-28T19:00:12.068Z"
}

Updated

List All Agents

Get Agent

Get url to upload profile avatar to

Get url to upload audio files

Get agent media download

Delete Agent

Get Agent

Get Agent Availability

Get Agent Workload

List Agents

Show child attributes

Create Agent

Show child attributes

Show child attributes

Update Agent

Show available items

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Update Agent

Show available items

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Update Agent Availability