---
title: "Invite a user to an organisation"
method: POST
path: "/v1/organisations/{organisationId}/invitations"
tags: ["Organisations"]
---

# Invite a user to an organisation

`POST /v1/organisations/{organisationId}/invitations`

## Request body

- InvitationRequest
  - `invitation` object, required
    - `role` 'organisation_admin' | 'organisation_member' | 'team_admin' | 'team_member' | 'mock_api_admin' | 'mock_api_editor' | 'mock_api_user' | 'api_template_admin' | 'api_template_editor' | 'api_template_user' | 'api_template_catalogue_admin' | 'api_template_catalogue_editor' | 'api_template_catalogue_user' | 'data_source_admin' | 'data_source_editor' | 'data_source_user' | 'key_admin' | 'key_editor' | 'key_user', required — The role of the new user within the organisation.
    - `aclObjectId` string, nullable — The ACL ID of the entity to invite the user to join. The `role` field must be valid for the type of ACL entity the user is being invited to. For instance, if the ACL entity is a team, the provided `role` must be either `team_member` or `team_admin`. If null, the user is not invited to a particular entity, but simply to the organisation.
    - `recipientEmailAddress` string, required — The email address of the user being invited.

## Response `201`

Success

- Invitation
  - `invitation` InvitationData, required
    - `id` string, required
    - `senderId` string, required — The ID of the user sending the invitation.
    - `recipientEmailAddress` string, required — The email address of the user being invited.
    - `newUser` boolean, required — Indicates whether the invited user already existed in the system.
    - `role` 'organisation_admin' | 'organisation_member' | 'team_admin' | 'team_member' | 'mock_api_admin' | 'mock_api_editor' | 'mock_api_user' | 'api_template_admin' | 'api_template_editor' | 'api_template_user' | 'api_template_catalogue_admin' | 'api_template_catalogue_editor' | 'api_template_catalogue_user' | 'data_source_admin' | 'data_source_editor' | 'data_source_user' | 'key_admin' | 'key_editor' | 'key_user', required — The role of the new user within the organisation.
    - `aclObjectId` string, nullable — The ACL ID of the entity the user is invited to join. If null, the user is not invited to a particular entity, but simply to the organisation.
    - `created` string, required
    - `links` object, required
      - `self` string, required

---

[API](https://skmtc.net/wiremock/apis/wiremock-cloud.md) · [All operations](https://skmtc.net/wiremock/apis/wiremock-cloud/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wiremock/wiremock-cloud/versions/93bebefc672f/schema)