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>"
            }
        ]
    }
}'

{
  "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>"
            ]
          }
        }
      }
    }
  }
}
POST
/
public
/
v1
/
submit
/
create_invitations

Authorizations

X-Stamp
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

Response

A successful response returns the following fields:

​
activity
object
required

The activity object containing type, intent, and result

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>"
            }
        ]
    }
}'

{
  "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>"
            ]
          }
        }
      }
    }
  }
}