/calls.add

POST/calls.add

Registers a new Call.

Request

Header Params

token

string

required

Authentication token. Requires scope: calls:write

Body Params application/x-www-form-urlencoded

created_by

string

optional

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.

date_start

integer

optional

Call start time in UTC UNIX timestamp format

desktop_app_join_url

string

optional

When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.

external_display_id

string

optional

An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.

external_unique_id

string

required

An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.

join_url

string

required

The URL required for a client to join the Call.

title

string

optional

The name of the Call.

users

string

optional

The list of users to register as participants in the Call. Read more on how to specify users here.

Request samples

Responses

Typical success response(200)

Typical error response(500)

Typical success response

HTTP Code: 200

Content Type : JSONapplication/json

#/definitions/700149

required

Additional properties

integer | number | string | boolean

optional

{
  "ok": true
}

Last modified: a year ago