Skip to main content
POST
/
v1
/
organisations
/
{organisationId}
/
invitations
curl --request POST \ --url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "invitation": { "role": "organisation_admin", "recipientEmailAddress": "[email protected]" } } '
{
  "invitation": {
    "id": "neqek",
    "senderId": "9gd5l",
    "recipientEmailAddress": "[email protected]",
    "newUser": true,
    "role": "organisation_admin",
    "created": "2024-10-30T19:28:23.802551Z",
    "links": {
      "self": "/v1/organisations/mgk7g/invitations/neqek"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Your API key prefixed by 'Token '

Path Parameters

​
organisationId
string
required

The ID of the organisation

Required string length: 5 - 10
Example:

"jjl8y"

Query Parameters

​
q
string

The search query to filter by. Partially matched against recipient email address.

Example:

"[email protected]"

Body

application/json
​
invitation
object
required

Response

201 - application/json

Success

​
invitation
object
required