Create a connect link

Creates a hosted page where someone without a Breakreach login (your end user, your client) connects social accounts into a workspace. Send them the url; they pick a network, authorize it, and come back to the page, then to redirectUrl when they click Done, with ?connected=<platforms>&workspace=<slug> appended. Accounts connected this way fire the account.connected webhook and count toward your plan. Only the workspace owner can create links.

post/v1/connect-links

Request

  • Base URL: https://api.breakreach.com
  • URL: https://api.breakreach.com/v1/connect-links
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

A unique string for this request, e.g. a UUID. A retry with the same key and body within 24 hours returns the first response (with the header Idempotent-Replayed: true) instead of running again. Printable ASCII, no spaces.

Request body

workspacestring

Workspace slug (optional, defaults to your first workspace)

platformsstring[]

Networks offered on the page (default: all)

redirectUrlstring uri

Where the Done button sends them: https, or http on localhost

expiresInHoursinteger

How long the link works (default 24)

Response

Created

Changes

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