Create Invitations

Create Invitations to join an existing Organization

POST

/

public

/

v1

/

submit

/

create_invitations

Authorizations

API Key

X-Stamp

string

header

required

Webauthn (Passkey)

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_INVITATIONS

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.invitations · array · required

A list of Invitations.

Show item details

parameters.invitations.receiverUserName

string

required

The name of the intended Invitation recipient.

parameters.invitations.receiverUserEmail

string

required

The email address of the intended Invitation recipient.

parameters.invitations.receiverUserTags · array · required

A list of tags assigned to the Invitation recipient. This field, if not needed, should be an empty array in your request body.

Show item details

Array item type: string

item field

parameters.invitations.accessType

enum<string>

required

Enum options: ACCESS_TYPE_WEB, ACCESS_TYPE_API, ACCESS_TYPE_ALL

parameters.invitations.senderUserId

string

required

Unique identifier for the Sender of an Invitation.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createInvitationsIntent

object

required

The createInvitationsIntent object

Show createInvitationsIntent details

activity.intent.createInvitationsIntent.invitations

array

required

A list of Invitations.

Show invitations details

activity.intent.createInvitationsIntent.invitations.receiverUserName

string

required

The name of the intended Invitation recipient.

activity.intent.createInvitationsIntent.invitations.receiverUserEmail

string

required

The email address of the intended Invitation recipient.

activity.intent.createInvitationsIntent.invitations.receiverUserTags

array

required

A list of tags assigned to the Invitation recipient. This field, if not needed, should be an empty array in your request body.

Show receiverUserTags details

activity.intent.createInvitationsIntent.invitations.receiverUserTags.item

string

required

item field

activity.intent.createInvitationsIntent.invitations.accessType

enum

required

accessType field

Enum options: ACCESS_TYPE_WEB, ACCESS_TYPE_API, ACCESS_TYPE_ALL

activity.intent.createInvitationsIntent.invitations.senderUserId

string

required

Unique identifier for the Sender of an Invitation.

activity.result

object

required

The result of the activity

Show result details

activity.result.createInvitationsResult

object

required

The createInvitationsResult object

Show createInvitationsResult details

activity.result.createInvitationsResult.invitationIds

array

required

A list of Invitation IDs

Show invitationIds details

activity.result.createInvitationsResult.invitationIds.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_invitations \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_INVITATIONS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "invitations": [
            {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                    "<string_element>"
                ],
                "accessType": "<ACCESS_TYPE_WEB>",
                "senderUserId": "<string>"
            }
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_INVITATIONS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createInvitationsIntent": {
            "invitations": [
              {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                  "<string_element>"
                ],
                "accessType": "<ACCESS_TYPE_WEB>",
                "senderUserId": "<string>"
              }
            ]
          }
        },
        "result": {
          "createInvitationsResult": {
            "invitationIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}