Create Link

Create a new link intent for account connection.

Request


POST /v1/links

Headers

Header	Value
`Authorization`	`Bearer YOUR_API_KEY`
`Content-Type`	`application/json`

Body

Field	Type	Required	Description
`provider`	string	Yes	Provider identifier (e.g., `tmobile`, `att`, `verizon`, `ubereats`)
`webhookUrl`	string	No	URL to receive completion webhook
`externalUserId`	string	No	Your identifier for the user
`metadata`	object	No	Arbitrary JSON passed through to the automation context

Response

201 Created


{
  "linkId": "link_abc123",
  "provider": "tmobile",
  "status": "pending",
  "appClipUrl": "https://appclip.example.com/link_abc123?code=clm_xxx",
  "expiresAt": 1704081600000,
  "createdAt": 1704067200000
}

Notes

Creates a link record only — no session is spawned until the link is claimed
The appClipUrl contains the claim code and is passed to the client SDK to initiate the flow
Links expire after 4 hours