tebarDocs
GuideDevelopersAPI ReferenceChangelog
Connect

Create a connect link

POST
/v1/profiles/{id}/connect-links

A page where your client connects their accounts into the profile ({id} may be its external_id). redirect_url's origin must be allowed in /v1/connect/redirect-origins (422 redirect_origin_not_allowed); state comes back unchanged.

Requires the write scope. Owner key or session only: a profile key gets 403 owner_key_required.

Authorization

bearer
headerAuthorizationBearer <token>

An API key (tb_live_...) from the dashboard, or an OAuth access token.

Path Parameters

id*string

Request Body

application/json
  1. body
redirect_url?string
Formaturi
Lengthlength <= 2000
state?string
Lengthlength <= 500
platforms?array<>
Items1 <= items

Response Body

The link.

application/json
  1. response
url*string

Usable once, until expires_at.

profile_id*string
Formatuuid
expires_at*string
Formatdate-time
Example Request
curl -X POST 'https://api.tebar.app/v1/profiles/string/connect-links' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "url": "string",
  "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
  "expires_at": "2019-08-24T14:15:22Z"
}