---
title: "Invite User to Organization"
method: POST
path: "/organizations/{orgId}/invitations"
tags: ["Invitations"]
---

# Invite User to Organization

`POST /organizations/{orgId}/invitations`

Invite a new user to your Organization.

This sends an email to someone inviting them to join your m3ter Organization.

## Path parameters

- `orgId` string, required

## Request body

- OrgUserInvitationRequest
  - `m3terUser` boolean
  - `version` integer
  - `firstName` string, required
  - `lastName` string, required
  - `contactNumber` string
  - `email` string, email, required
  - `permissionPolicyIds` string[] — The IDs of the permission policies the invited user has been assigned. This controls the access rights and privileges that this user will have when working in the m3ter Organization.
  - `dtEndAccess` string, date-time — The date when access will end for the user *(in ISO-8601 format)*. Leave blank for no end date, which gives the user permanent access.
  - `dtExpiry` string, date-time — The date when the invite expires *(in ISO-8601 format)*. After this date the invited user can no longer accept the invite. By default, any invite is valid for 30 days from the date the invite is sent.

## Response `200`

Returns the Invitation

- OrgUserInvitationResponse
  - `id` string, required — The UUID of the entity.
  - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
  - `email` string, required — The email address of the invitee. The invitation will be sent to this email address.
  - `permissionPolicyIds` string[], required — The IDs of the permission policies the invited user has been assigned. This controls the access rights and privileges that this user will have when working in the m3ter Organization.
  - `firstName` string, required — The first name of the invitee.
  - `lastName` string, required — The surname of the invitee.
  - `dtEndAccess` string, date-time, required — The date that access will end for the user *(in ISO-8601 format)*. If this is blank, there is no end date meaning that the user has permanent access.
  - `dtExpiry` string, date-time, required — The date when the invite expires *(in ISO-8601 format)*. After this date the invited user can no longer accept the invite. By default, any invite is valid for 30 days from the date the invite is sent.
  - `invitingPrincipalId` string, required — The UUID of the user who sent the invite.
  - `accepted` boolean, required — Boolean indicating whether the user has accepted the invitation. * TRUE - the invite has been accepted. * FALSE - the invite has not yet been accepted.
  - `dtCreated` string, date-time — The DateTime when the invitation was created *(in ISO-8601 format)*.
  - `dtLastModified` string, date-time — The DateTime when the invitation was last modified *(in ISO-8601 format)*.
  - `createdBy` string — The UUID of the user who created the invitation.
  - `lastModifiedBy` string — The UUID of the user who last modified the invitation.

## Other responses

- `4XX` — Error message
- `5XX` — Error message

---

[API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/versions/ac93d1a9e6d9/schema)