Invite Organisation Member
Add an existing user to the organisation by email.
Authorization: members:invite, and the caller must hold every
permission of the role it hands out (403 permission_escalation).
The owner role is never assignable by invite (422
owner_role_not_assignable). Without a role the organisation's
default role applies. Personal organisations cannot receive additional
members.
The invited user must already have an account (matched by case-insensitive email) - this does not send an email invite or provision a new account. Fails with 409 if already a member.
Authorization
OAuth2AuthorizationCodeBearer In: header
Path Parameters
uuidQuery Parameters
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Invite an existing user. Without a role the organisation's default role applies.
role is the deprecated system-key form of role_id; at most one of
the two may be set.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/organisations/497f6eca-6276-4993-bfeb-53cbbbba6f08/members" \ -H "Content-Type: application/json" \ -d '{ "email": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "role": "string", "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9", "role_ref": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "name": "string", "is_system": true }, "joined_at": "2019-08-24T14:15:22Z", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "username": "string", "display_name": "string", "avatar_url": "string" }}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}