Refresh branded caller ID

Read the number's Telnyx reputation and update the branded caller ID status.

POSThttps://api.tried.com.au/refresh-branded-caller-id/{id}

Needs keys Reads the number's reputation from Telnyx and saves the new status. Real lookups need TELNYX_API_KEY. In mock mode the first refresh approves the record.

Telnyx reputation	New `status`
No spam risk reported yet	`pending`
Spam risk `high`	`rejected`
Any other spam risk	`approved`

Request#

Path parameter	Type	Required	Description
`id`	string	Yes	The record ID, for example `bcid_7e2a91c4d08f5b36e1a9c7d0`.

This endpoint takes no query or body parameters.

Example request#

curl -X POST https://api.tried.com.au/refresh-branded-caller-id/bcid_7e2a91c4d08f5b36e1a9c7d0 \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch(
  "https://api.tried.com.au/refresh-branded-caller-id/bcid_7e2a91c4d08f5b36e1a9c7d0",
  { method: "POST", headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` } },
);
const branded = await res.json();

import os, requests

res = requests.post(
    "https://api.tried.com.au/refresh-branded-caller-id/bcid_7e2a91c4d08f5b36e1a9c7d0",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
branded = res.json()

Response#

200 OK

The updated record. See Create branded caller ID for the fields.

{
  "branded_caller_id": "bcid_7e2a91c4d08f5b36e1a9c7d0",
  "phone_number": "+14155550123",
  "display_name": "Harbour Dental",
  "call_reason": "Appointment reminder",
  "status": "approved",
  "provider": "telnyx",
  "provider_reference": "c41f9a2e-6b07-4d1a-9e35-8f2b1d6c0a47",
  "created_timestamp": 1792396800000,
  "last_modification_timestamp": 1792483200000
}

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `numbers` scope. Members get `The member role is read-only`.
`404`	`Branded caller ID bcid_... not found` in this workspace.
`429`	Rate limit exceeded. See Rate limits.
`500`	The Telnyx reputation lookup failed.

See Errors for the body format.