v1

latestOpenAPI 3.1.0Apache 2.02026-07-2610193196.3 KB
Organisations

Invite a user to an organisation

post/v1/organisations/{organisationId}/invitations

Request body

Example request

{
  "invitation": {
    "role": "organisation_admin",
    "aclObjectId": "8ndxc",
    "recipientEmailAddress": "docsmember2@example.com"
  }
}

Response

Success

Example response

{
  "invitation": {
    "id": "neqek",
    "senderId": "9gd5l",
    "recipientEmailAddress": "tom+docsmember2@wiremock.io",
    "newUser": true,
    "aclObjectId": "8ndxc",
    "created": "2024-10-30T19:28:23.802551Z",
    "links": {
      "self": "/v1/organisations/mgk7g/invitations/neqek"
    }
  }
}