Skip to main content
POST
/
host-connections
Error
A valid request URL is required to generate request examples
{
  "host_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "guest_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "host_name": "<string>",
  "host_email": "jsmith@example.com",
  "owner_email": "jsmith@example.com",
  "status": "connected",
  "archived": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "active_action_type": "documents_update_request",
  "active_action_updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Body

application/json
​
host_organization_id
string<uuid>
required
​
invitation_token
string | null
Required string length: 10 - 2000

Response

Successful Response

​
host_organization_id
string<uuid>
required
​
guest_organization_id
string<uuid>
required
​
host_name
string
required
Required string length: 1 - 300
​
host_email
string<email>
required
Required string length: 3 - 100
​
owner_email
string<email>
required
Required string length: 3 - 100
​
status
enum<string>
required
Available options:
connected,
disconnected
​
archived
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
archived_at
string<date-time> | null
​
active_action_type
enum<string> | null
Available options:
documents_update_request,
analytics_request
​
active_action_updated_at
string<date-time> | null