Skip to main content

Invite

Invite Object

FieldTypeDescription
codestringa unique, random invite code
organisationpartial organisation objectthe organisation this invite is for
domainstringfully qualified domain name this invite is valid for or null

Get Invite

GET /invites/{invite.code}

Returns the invite object for the given invite code

Revoke Invite

DELETE /invites/{invite.code}

This operation will mark the invite as revoked.

Use Invite

POST /invites/{invite.code}

If the user is able to use the invite will return 200 OK. If the user is already a member of the organisation will return 204 NO CONTENT. If the invite does not exist or is invalid or expired then will return 404 NOT FOUND.