curl --request POST \
--url https://api.orbit.devotel.io/api/v1/me/favorites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target_kind": "pstn",
"target_value": "+442071234567",
"label": "Front desk",
"sort_order": 10
}
'{
"data": {
"favorite": {
"id": "<string>",
"target_kind": "pstn",
"target_value": "<string>",
"label": "<string>",
"sort_order": 123,
"created_at": "2023-11-07T05:31:56Z"
}
},
"meta": {}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Create a favorite
Pin a new dial target to the caller’s favorites so it renders as a one-tap entry on the softphone/dialpad. Caps each user at 50 pins (409 FAVORITE_LIMIT_REACHED when full) and rejects a duplicate target (409 FAVORITE_ALREADY_EXISTS). The target format is checked against target_kind: pstn values must be E.164 and sip values must start with sip: (422 otherwise). Favorites store dial INTENT only — placing a call to a pinned target routes through the normal outbound calling surface.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/me/favorites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target_kind": "pstn",
"target_value": "+442071234567",
"label": "Front desk",
"sort_order": 10
}
'{
"data": {
"favorite": {
"id": "<string>",
"target_kind": "pstn",
"target_value": "<string>",
"label": "<string>",
"sort_order": 123,
"created_at": "2023-11-07T05:31:56Z"
}
},
"meta": {}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Body
What the pinned dial target is: pstn (a public E.164 phone number, e.g. +442071234567), extension (a short internal extension), contact_id (a CRM/directory reference), or sip (a SIP URI beginning sip:). Drives validation of target_value.
pstn, extension, contact_id, sip The dial target itself. Format must match target_kind: E.164 for pstn (422 otherwise), a sip:-prefixed URI for sip, free-form for extension and contact_id.
1 - 512Display label the dialpad shows for this pin (≤ 64 chars). Omit or pass null to render the target itself.
64Position in the favorites list — lower sorts first. Defaults to 0 (top).
0 <= x <= 100000