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' \
  --data '
{
  "domains": [
    "<string>"
  ],
  "scope": "<string>",
  "scopeType": "<string>",
  "widgetId": "<string>",
  "scopeName": "<string>"
}
'
{
  "autojoinDomains": [
    {
      "id": "<string>",
      "domain": "<string>"
    }
  ],
  "invitation": {
    "id": "invitation-12345",
    "accountId": "account-12345",
    "attributes": {},
    "clickThroughs": 5,
    "configurationAttributes": {},
    "createdAt": "2023-10-01T12:00:00Z",
    "deactivated": false,
    "deliveryCount": 3,
    "deliveryTypes": [
      "email",
      "sms"
    ],
    "foreignCreatorId": "creator-12345",
    "invitationType": "single_use",
    "modifiedAt": "2023-10-01T12:00:00Z",
    "status": "queued",
    "target": [
      {
        "type": "email",
        "value": "[email protected]"
      }
    ],
    "views": 10,
    "widgetConfigurationId": "widget-12345",
    "projectId": "project-67890",
    "groups": [
      {
        "type": "workspace",
        "id": "workspace-12345",
        "name": "Development Team"
      }
    ],
    "accepts": [
      {
        "id": "accept-12345",
        "status": "accepted"
      }
    ],
    "scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
    "scopeType": "project",
    "expired": false,
    "expires": "2023-11-01T12:00:00Z"
  }
}

Body

application/json

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

domains
string[]
required

The domains for autojoin configuration

scope
string
required

The scope identifier

scopeType
string
required

The scope type (maps to groupType in database)

widgetId
string
required

The ID of the widget

scopeName
string

Optional scope name

Response

Successfully synced autojoin domains

autojoinDomains
object[]
required

List of autojoin domain configurations

invitation
object
required

Invitation entry associated with autojoin for this scope