Sample - Slack Web API
POST/calls.add

Register a new call

Creates a registration for a third-party call. Supply a unique external_unique_id and a join_url, and optionally provide display, timing, creator, and participant details.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 8 body fields
tokenstringrequired
Authentication token supplied in the request header; the required scope is `calls:write`.

Call registration details for a third-party call.

external_unique_idstringrequired
An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
external_display_idstringoptional
An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
join_urlstringrequired
The URL required for a client to join the Call.
desktop_app_join_urlstringoptional
When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
date_startintegeroptional
Call start time in UTC UNIX timestamp format
titlestringoptional
The name of the Call.
created_bystringoptional
The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required.
usersstringoptional
The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users).

2 status codes
200Returns an object with `ok` set to true confirming that the call was registered.
okbooleanrequired
Allowed:true
defaultReturned when the call registration request cannot be processed; the response contains `ok` set to false.
okbooleanrequired
Allowed:false

Error handling

external_unique_id and join_url must both be supplied, and external_unique_id must be unique among calls from the third-party service. When the request does not use a user token, created_by must identify a valid Slack user.