API Reference/Endpoints

Create a hosted auth link

POST/api/linkedin/gateway/hosted/accounts/link

Generates a one-time URL that hands someone a ready-made login screen to connect or reconnect an account — no custom sign-in form to build. The link expires on its own and can be limited to a single use.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Body parameters

FieldTypeDescription

type *"create" | "reconnect"Whether the link connects a brand-new account or restores an existing one.

account_idstringRequired, and must match reconnect_account, when type is reconnect — this is how Warmably confirms you own the account before handing out a link for it. Not used for type: create, since there's no existing account yet to scope to.

reconnect_accountstringRequired for type: reconnect — the account the hosted flow will restore.

providersstring | string[]Required for type: create — which channels the flow may connect, e.g. ["LINKEDIN"].

expiresOn *stringISO 8601 timestamp after which the link stops working.

api_url *stringBase URL the hosted flow calls back into once it's done.

namestringA label for the resulting account, shown in the dashboard.

success_redirect_urlstringWhere to send the browser after a successful connection.

failure_redirect_urlstringWhere to send the browser if the flow fails.

notify_urlstringA webhook to call once the flow finishes, independent of the redirects.

single_usebooleanInvalidate the link after its first successful use.

proxyobjectOptional { protocol, host, port, username, password } to route the new connection through your own proxy.

Response fields

FieldTypeDescription

urlstringThe hosted page to send the end user to.

Warmably only ever creates LINKEDIN accounts through this flow — pass providers accordingly, or omit it to allow the default set.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. account_id doesn't belong to this key (reconnect links only).·404 Not Found. reconnect_account doesn't exist upstream.