admin_users_invite

POST /admin.users.invite

Copy endpoint

https://slack.com/api

Invite a user to a workspace.

Parameters

header Header Parameters

Name	Type
`token` required Authentication token. Requires scope: `admin.users:write`	string

Request Body

application/x-www-form-urlencoded required

{
channel_ids: string;
custom_message?: string;
email: string;
guest_expiration_ts?: string;
is_restricted?: boolean;
is_ultra_restricted?: boolean;
real_name?: string;
resend?: boolean;
team_id: string;
}

Responses

200 application/json

Typical success response

{ ok:

DefsOkTrue

type DefsOkTrue = true

; }

default application/json

Typical error response

{ ok:

DefsOkFalse

type DefsOkFalse = false

; }