tebarDocs
GuideDevelopersAPI ReferenceChangelog
Profiles

Create a profile

POST
/v1/profiles

An external_id already in use returns that profile with 200, so the request is safe to repeat. Free plan: 403 plan_required; more than 1,000 profiles: 422 profile_limit.

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.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100
external_id?string
Length1 <= length <= 128

Response Body

The existing profile.

application/json
  1. response
id*string
Formatuuid
name*string
external_id*|

The client's id in your own system.

is_default*boolean
created_at*string
Formatdate-time
Example Request
curl -X POST 'https://api.tebar.app/v1/profiles' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
Example Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "external_id": "string",
  "is_default": true,
  "created_at": "2019-08-24T14:15:22Z"
}

List profiles GET

Oldest first, so the default profile leads. Requires the read scope. Owner key or session only: a profile key gets 403 owner_key_required.

Get a profile GET

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