--- title: "Create a bot" url: "https://docs.unified.to/calendar/bot/Create_a_bot" description: "Create a bot with Unified's Bot API (POST /calendar/{connection_id}/bot). Filter by fields and raw." date: "2026-11-05T14:07:11.446Z" updated: "2026-11-05T14:07:11.446Z" --- # Create a bot Updated: November 5, 2026 POST/calendar/{connection\_id}/bot Creates a CalendarBot. Provide the unified CalendarBot fields in the request body; they are mapped to the provider's API. Returns the created CalendarBot. ## Parameters **fields**string array id created\_at updated\_at name meeting\_url event\_id status status\_changes join\_at started\_at ended\_at recording\_config automatic\_leave meeting\_metadata participants recording\_id raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection ## Payload **id**string **created\_at**date-time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **name**string Display name for the bot in the meeting **meeting\_url**string URL of the meeting to join **event\_id**string Reference to calendar\_event if scheduled via calendar (reference to CalendarEvent) **status** enum Valid values: "READY" "JOINING\_CALL" "IN\_WAITING\_ROOM" "IN\_CALL\_NOT\_RECORDING" "RECORDING\_PERMISSION\_ALLOWED" "RECORDING\_PERMISSION\_DENIED" "IN\_CALL\_RECORDING" "CALL\_ENDED" "DONE" "FATAL" **status\_changes** array History of status changes **join\_at**date-time When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **started\_at**date-time When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **ended\_at**date-time When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **recording\_config**object **automatic\_leave**object **meeting\_metadata**object **participants** array **recording\_id**string Reference to calendar\_recording when ready **raw** ## Returns [CalendarBot](https://docs.unified.to/calendar/bot/model.md) | Response field | Type | Required | Description | | -------------------------------------------------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | | | created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | Display name for the bot in the meeting | | meeting\_url | string | No | URL of the meeting to join | | event\_id | string | No | Reference to calendar\_event if scheduled via calendar (reference to CalendarEvent) | | status | enum | No | Values: READY, JOINING\_CALL, IN\_WAITING\_ROOM, IN\_CALL\_NOT\_RECORDING, RECORDING\_PERMISSION\_ALLOWED, RECORDING\_PERMISSION\_DENIED, IN\_CALL\_RECORDING, CALL\_ENDED, DONE, FATAL | | status\_changes | CalendarBotStatusChange\[\] | No | History of status changes | | status\_changes\[\].status | enum | No | Values: READY, JOINING\_CALL, IN\_WAITING\_ROOM, IN\_CALL\_NOT\_RECORDING, RECORDING\_PERMISSION\_ALLOWED, RECORDING\_PERMISSION\_DENIED, IN\_CALL\_RECORDING, CALL\_ENDED, DONE, FATAL | | status\_changes\[\].changed\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | status\_changes\[\].sub\_code | string | No | Platform-specific status sub-code | | status\_changes\[\].message | string | No | Human-readable status message | | join\_at | string (date-time) | No | When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | started\_at | string (date-time) | No | When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | ended\_at | string (date-time) | No | When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | recording\_config | object | No | | | recording\_config.record\_video | boolean | No | | | recording\_config.record\_audio | boolean | No | | | recording\_config.record\_transcript | boolean | No | | | recording\_config.record\_chat | boolean | No | | | recording\_config.record\_screenshare | boolean | No | | | recording\_config.transcription | CalendarBot\_recording\_config\_transcription | No | | | recording\_config.transcription.provider | enum | No | Values: MEETING\_CAPTIONS, AWS\_TRANSCRIBE, GOOGLE\_SPEECH, ASSEMBLYAI, DEEPGRAM, CUSTOM | | recording\_config.transcription.mode | enum | No | Values: PRIORITIZE\_ACCURACY, PRIORITIZE\_LOW\_LATENCY | | recording\_config.transcription.language | string | No | ISO language code (e.g., 'en-US') | | recording\_config.transcription.enable\_speaker\_labels | boolean | No | Whether to identify speakers in transcript | | recording\_config.transcription.enable\_word\_timestamps | boolean | No | Whether to include word-level timestamps | | automatic\_leave | object | No | | | automatic\_leave.waiting\_room\_timeout | number | No | Seconds to wait in waiting room before leaving (default: 1200) | | automatic\_leave.no\_participants\_timeout | number | No | Seconds to wait when no other participants before leaving (default: 2) | | automatic\_leave.detect\_bots | boolean | No | Whether to leave if only bots remain | | meeting\_metadata | object | No | | | meeting\_metadata.title | string | No | | | meeting\_metadata.platform | string | No | 'zoom', 'webex', 'google\_meet', etc. | | meeting\_metadata.host\_name | string | No | | | meeting\_metadata.host\_email | string | No | | | meeting\_metadata.meeting\_identifier | string | No | Platform-specific meeting identifier (not a unified object ref) | | meeting\_metadata.started\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | meeting\_metadata.ended\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | meeting\_metadata.participant\_count | number | No | | | participants | CalendarBotParticipant\[\] | No | | | participants\[\].id | string | No | | | participants\[\].name | string | No | | | participants\[\].email | string | No | | | participants\[\].is\_host | boolean | No | | | participants\[\].is\_cohost | boolean | No | | | participants\[\].joined\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | participants\[\].left\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | participants\[\].platform | string | No | Platform-specific participant identifier | | participants\[\].is\_bot | boolean | No | Whether this participant is a bot | | participants\[\].is\_self | boolean | No | Whether this participant is the current bot | | participants\[\].speaking | boolean | No | Whether participant is currently speaking | | participants\[\].webcam\_on | boolean | No | Whether participant's webcam is on | | participants\[\].screenshare\_on | boolean | No | Whether participant is sharing screen | | participants\[\].platform\_metadata | object | No | Platform-specific metadata | | recording\_id | string | No | Reference to calendar\_recording when ready | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const results = await sdk.calendar.createCalendarBot({ connectionId, calendarBot: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'POST', url: 'https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("POST", "https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot?fields=&raw= req, _ := http.NewRequest("POST", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.post(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request POST \ --url 'https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```