API Docs / Operations / Connections / Create Connection

Create Connection

POST /tenants/{tenant}/connections

Initiates a connection for one of the tenant's contacts: Out shares the tenant's CIS details with the contractor the contact stands for, In invites the subcontractor the contact stands for. The other party is emailed at the given address (and the tenant is told what happens next). 409 when the contact already has a connection on that side.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

Request Body*

{
  "contact": "string",
  "direction": "In",
  "email": "user@example.com"
}

Responses

201 Created
400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json
409 Conflict
application/problem+json