Skip to main content
GET
Caller ID Details
The business details carriers need before calls from a Registered caller ID number can show your business name. There is one set per workspace, used by every line with the add-on. This is the same data as the Caller ID details form in the dashboard. See Registered caller ID setup. Use a workspace API key (tuco_…).

Endpoint

  • Method: GET to read, PUT to save a draft or submit
  • Path: /api/workspace/caller-id-profile
  • Auth: Authorization: Bearer tuco_xxxxxxxxxxxxx

Read — GET

object
The saved details. If nothing is saved yet, an empty profile is returned, pre-filled where we can: company legal name and address from the workspace’s newest line order, and the contact’s name and email from the user the request is made as (for an API key, the user who created it). callReasons starts as ["Sales Call"].
string | null
null (nothing saved yet), draft (saved, not submitted) or submitted (sent to us for registration). PUT only ever sets draft or submitted. The dashboard also recognizes in_review, verified and rejected, and treats every value other than null and draft as submitted. Do the same.
string | null
When the details were last submitted (ISO 8601), or null.
boolean
true when the workspace paid for Registered caller ID at checkout or a line has the add-on.
boolean
true when nothing is saved yet and profile was pre-filled from a line order or the user.

Save or submit — PUT

PUT replaces the whole saved profile. A field you leave out is saved as empty. To change one field, GET the profile first, change it, and send it all back.

Profile fields

“Submit” means the field is required when submit is true. Text is trimmed. A draft can be half-filled. It is only rejected for values that are present but wrong: a displayName over 35 characters or with emoji, a malformed ein, contact.email or website, an entityType / industry / employees value not on its list, or a callingAreaCode that isn’t 3 digits.

Response (200)

profile is what was saved, after trimming and dropping unknown call reasons. To send changes after submitting, PUT again with submit: true. A later draft save (submit left out) sets status back to draft; submittedAt keeps the time of the last submit.

Rejected (422)

missing and invalid hold field paths such as contact.title or billingAddress.zip. Nothing is saved when the request is rejected.

Error responses

What happens after you submit

We register your business with the carriers, which usually takes a few business days. The main contact signs one short authorization letter. Once a line’s Registered caller ID is live, its calling add-ons show status: "active" and the callingNumber its calls go out from.

Call reasons

Sales Call, Follow-Up Calls, Returning Your Call, Responding to Your Inquiry, Customer Service, Account Services, Your Account, Account Notification, Account Alert, Agent Call Back, Appointment Confirmation, Appointment Reminder, Confirm Appointment, Reschedule Request, Response Requested, General Support, Technical Support, Policy Update, Accounting Department, Confirm Status, Identity Verification, Fraud Alert, Confirm Card Use, Confirm Order, Order Confirmation, Your Order, Confirm Receipt, Delivery ETA, Today's Delivery, Upcoming Delivery, Item Ready, Order Ready, Reservation Ready, Rx Ready, Recall, Service Outage Notification, Verification Code, Investor Relations, Flight Arrival, Flight Boarding, Flight Cancellation, Flight Delay, School Closing Alert, Snow Alert, Weather Alert Values are case-sensitive.

Industries

financial, finance, banking, collections, accounting, billing, insurance, legal, law, real estate, property, sales, marketing, business, customer service, support, software, technology, tech, telecom, communications, healthcare, health, medical, pharmacy, education, retail, ecommerce, delivery, shipping, logistics, travel, hospitality, hotel, media, surveys, market research, notifications, scheduling, government, public, charity, nonprofit