Connections

Create connections for a set of domains in one call

Fans out the same idempotent upsert as single-domain create. Each domain is independent: a bad domain is reported failed and the batch continues; a domain already connected under this app returns already. Max 200 domains per call.

Callable with an app scoped widget token or straight from your server with an API key, in which case the connections are created on the key's application, or on application_id when that names another application of the same tenant. A viewer's key is refused.

end_user_ref labels every connection the call creates, the way it does on a single create: an agency adds a client's domains together under the client's name, and the Domains page shows, filters and exports the label. It is set once, when the connection is created. A domain that already exists keeps the label it has and is reported already.

A workspace with no subscription yet connects its first ten domains, or the number an operator set, without one; the rest of a list are reported failed with the reason, one by one, until it starts its trial.

post/connections:bulk

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections:bulk
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

domainsstring[] required
batch_idstring

correlates every domain connected in one session.

end_user_refstring

Your own label for these domains, such as a client's name or your id for the customer they belong to. Stored on each connection this call creates and echoed back by the connection reads.

application_idstring

API key callers only: create the connections on this application of the key's tenant instead of the key's own. A widget token may only name its own application.

Response

Per-domain results

Changes

No recorded changes to this operation across all 1 revision of this API.