Create invitations

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: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_INVITATIONS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "invitations": [
            {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                    "<string>"
                ],
                "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": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createInvitationsIntent": {
            "invitations": [
              {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                  "<string>"
                ],
                "accessType": "<ACCESS_TYPE_WEB>",
                "senderUserId": "<string>"
              }
            ]
          }
        },
        "result": {
          "createInvitationsResult": {
            "invitationIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

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: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_INVITATIONS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "invitations": [
            {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                    "<string>"
                ],
                "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": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createInvitationsIntent": {
            "invitations": [
              {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                  "<string>"
                ],
                "accessType": "<ACCESS_TYPE_WEB>",
                "senderUserId": "<string>"
              }
            ]
          }
        },
        "result": {
          "createInvitationsResult": {
            "invitationIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

POST

public

submit

create_invitations

Authorizations

X-Stamp

string

required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

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

The parameters object containing the specific intent data for this activity.

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.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

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 fieldEnum 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

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

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: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_INVITATIONS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "invitations": [
            {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                    "<string>"
                ],
                "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": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createInvitationsIntent": {
            "invitations": [
              {
                "receiverUserName": "<string>",
                "receiverUserEmail": "<string>",
                "receiverUserTags": [
                  "<string>"
                ],
                "accessType": "<ACCESS_TYPE_WEB>",
                "senderUserId": "<string>"
              }
            ]
          }
        },
        "result": {
          "createInvitationsResult": {
            "invitationIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

Create authenticators Create Oauth providers

Activities

Queries

Create invitations

Authorizations

Body

Response