Invite a tenant member

Invites a user to join the tenant and assigns roles to them within the tenant's context. If the user has not registered to the Self Service Portal yet, then they will receive an email with a link to accept the invite. If the user has already registered, then they will be added as a member to the tenant immediately.

Analytics Events

TENANT_MEMBER_INVITATION_CREATE_STARTTENANT_MEMBER_INVITATION_CREATE_SUCCESSTENANT_MEMBER_INVITATION_CREATE_FAIL

POST/v1/tenants/{tenantId}/invitations

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantIdstring

Identifier of the tenant to add the member to.

Formatuuid

Request Body

emailstring

Formatemail

rolesarray<string>

The roles assigned to the user in the context of this tenant.

Items1 <= items

Response Body

curl -X POST "https://manage.mattr.global/v1/tenants/543e0579-87b9-4705-be78-8f7f54709838/invitations" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john-doe@example.com",
    "roles": [
      "dts-provider",
      "issuer"
    ]
  }'

curl -X POST "https://manage.mattr.global/v1/tenants/543e0579-87b9-4705-be78-8f7f54709838/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "john-doe@example.com",    "roles": [      "dts-provider",      "issuer"    ]  }'

{
  "userId": "8f6d40a9-d913-45e8-aa3e-8c99d62cd8fb",
  "status": "Active",
  "inviteExpiresAt": "2025-08-22T07:46:09.510Z"
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

"Unauthorized"

Empty

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}