Send an invitation

Sends an invitation in your WorkOS environment.

POST

Body

Arguments

stringrequired

The email address of the recipient.

string

The ID of the organization that the recipient will join.

string

The role that the recipient will receive when they join the organization in the invitation.

number

How many days the invitations will be valid for. Must be between 1 and 30 days. Defaults to 7 days if not specified.

string

The ID of the user who invites the recipient. The invitation email will mention the name of this user.

string

The locale to use when rendering the invitation email. See supported locales.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/workOS/actions/send-an-invitation/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "arguments": {
    "email": ""
  }
}'

{
  "success": true,
  "data": [
    {
      "accepted_at": "2026-05-07T12:00:00.000Z",
      "accepted_user_id": "string",
      "created_at": "2026-05-07T12:00:00.000Z",
      "email": "ava@example.com",
      "expires_at": "2026-05-07T12:00:00.000Z",
      "id": "string",
      "inviter_user_id": "string",
      "message": "string",
      "object": "string",
      "organization_id": "string",
      "revoked_at": "2026-05-07T12:00:00.000Z",
      "state": "string",
      "token": "string",
      "updated_at": "2026-05-07T12:00:00.000Z"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.