Invite a member

Invite a person to the organization by email.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId?string

Organization to invite into. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

Length1 <= length

email*string

Email address to invite.

Formatemail

role?string

Role to grant on acceptance. Defaults to "member".

Default"member"

Value in

"admin"
"member"

Response Body

`application/json`

curl -X POST "https://example.com/members/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

{  "invitation": {    "id": "string",    "email": "user@example.com",    "role": "admin",    "status": "string",    "createdAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z"  }}

Request Body

Response Body

201application/json

`application/json`