Skip to main content
POST
/
api
/
v1
/
invitations
/
autojoin
Configure autojoin domains for a target scope
curl --request POST \
  --url https://api.example.com/api/v1/invitations/autojoin \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "domains": [
    "<string>"
  ],
  "scope": "<string>",
  "scopeType": "<string>",
  "componentId": "<string>",
  "scopeName": "<string>"
}
'
{
  "autojoinDomains": [
    {
      "id": "<string>",
      "domain": "<string>"
    }
  ],
  "invitation": {
    "id": "invitation-12345",
    "accountId": "account-12345",
    "attributes": {},
    "clickThroughs": 5,
    "configurationAttributes": {},
    "formSubmissionData": {
      "email": {
        "type": "email",
        "value": "invitee@example.com"
      },
      "personalMessage": {
        "type": "text",
        "value": "Join me on AcmeTasks!"
      },
      "role": {
        "type": "select",
        "value": "admin"
      }
    },
    "createdAt": "2023-10-01T12:00:00Z",
    "deactivated": false,
    "deliveryCount": 3,
    "deliveryTypes": [
      "email",
      "phone"
    ],
    "foreignCreatorId": "creator-12345",
    "invitationType": "single_use",
    "modifiedAt": "2023-10-01T12:00:00Z",
    "status": "queued",
    "target": [
      {
        "type": "email",
        "value": "foo@bar.com"
      }
    ],
    "views": 10,
    "widgetConfigurationId": "widget-12345",
    "widgetId": "widget-uuid",
    "deploymentId": "deployment-12345",
    "scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
    "scopeType": "project",
    "expired": false,
    "source": "email",
    "subtype": "pymk",
    "expires": "2023-11-01T12:00:00Z",
    "metadata": {
      "customerId": "12345",
      "source": "web"
    },
    "passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vortexsoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Body

application/json

Autojoin configuration for a target scope. Provide the complete list of domains to sync.

domains
string[]
required

The list of email domains that allow the user to join the entity defined by scope. If the list includes any webmail domains (e.g., gmail.com) the response will be a 400.

scope
string
required

The ID in your system of the entity to which autojoin applies (e.g., workspace, team, org).

scopeType
string
required

The name of the entity that the ID passed in scope refers to (e.g., “workspace”, “organization”, “team”). Ensures that you don’t have any issues disambiguating the ID in cases where there are multiple types of entities to which someone can be invited. If your system does not have a scope type, use "default".

componentId
string
required

The ID of the component

scopeName
string

The name of the scoped entity. For example, if the invitation is to join a workspace, scope would be the workspace ID, scopeType would identify it as a "workspace", and scopeName would be the name of the given workspace (e.g.,"AcmeTasks Workspace").

Response

Successfully synced autojoin domains

autojoinDomains
object[]
required

List of autojoin domain configurations

invitation
object
required

Invitation entry associated with autojoin for this scope