POST
/
organizations
/
{orgId}
/
invitations
/
email
Send invitations via email
curl --request POST \
  --url https://console.gmicloud.com/api/v1/organizations/{orgId}/invitations/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invitees": [
    {
      "email": "user@example.com",
      "role": "org_user"
    }
  ]
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

An access token used to authenticate a user and grant access to restricted APIs. It is issued by session APIs. For status codes related to this header, refer to the Common Headers Documentation.

Path Parameters

​
orgId
string<uuid>
required

The organization's ID.

  • Must be a valid UUID.
Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Body

application/json

The invitations request body.

The body is of type object.

Response

Successfully sent the invitations.