Add Guest To Task

Share a task with a guest.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

SecurityAuthorization Token
Request
path Parameters
task_id
required
string
guest_id
required
number <double>
query Parameters
include_shared
boolean

Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.

custom_task_ids
boolean

If you want to reference a task by it's custom task id, this value must be true.

team_id
number <double>

Only used when the custom_task_ids parameter is set to true.

For example: custom_task_ids=true&team_id=123.

Request Body schema: application/json
permission_level
required
string

Can be read (view only), comment, edit, or create (full).

Responses
200
post/v2/task/{task_id}/guest/{guest_id}
Request samples
application/json
{
  • "permission_level": "read"
}
Response samples
application/json
{
  • "guest": {
    }
}