Create Invitation

Invite someone by email. MindCloud emails them a link to join your company.

POST

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

stringrequired

Who to invite.

string

The role they get when they join, from List Roles. Leave it out for the built-in Member role.

Response fields

idstring

The invitation's id: the pending member's userId (List Members), until they sign up.

emailstring

Who was invited.

roleIdstring

The role they get when they join, from List Roles.

roleNamestring

That role's name.

statusstring

pending while they have not signed up. Create Invitation answers accepted for someone who already had a MindCloud account and joined at once; they are then a member (List Members).

pending
accepted

createdOndate

When they were invited.