Sign in
Branded Calling

Edit or resubmit a caller identity

Allowed while the identity is requested, changes_requested or rejected. Answering a change request (send reviewAnswers keyed by point id, and any edited fields) puts it back in review. On a carrier rejection the edits are applied at the carrier and the identity is resubmitted straight away.

patch/v1/branded-calling/identities/{id}

Path parameters

idstring required

Request body

displayNamestring

Shown on the callee's screen. No emoji.

callReasonsstring[]

1 to 10 reasons you call, each up to 64 characters. Pick from GET /v1/branded-calling/call-reasons to skip manual vetting.

logoUrlstring

HTTPS URL of a PNG, JPEG, WebP or SVG logo. Zernio converts it to the 256x256 BMP the carriers require and hosts it.

reviewAnswersobject

One entry per point id of the open reviewRequest. A text point takes text; a link point takes url; file and link_or_file points take url set to the URL of a file you uploaded first (POST /v1/media/upload). A point id that is not on the open request is a 422.

reviewNotestring

Response

The updated identity.

idstring
enterpriseIdstring
displayNamestring
callReasonsstring[]
callReasonsPreApprovedboolean

Every call reason matches the carrier catalogue (GET /v1/branded-calling/call-reasons); anything else is vetted by hand and takes longer.

logoUrlstring nullable

The image you sent. Zernio hosts the 256x256 BMP the carriers require.

status'requested' | 'changes_requested' | 'rejected' | 'pending_email_verification' | 'in_review' | 'verified' | 'suspended' | 'expired' | 'permanently_rejected'

requested = in Zernio review; changes_requested = answer the review (PATCH); pending_email_verification = confirm the code emailed to the authorizer; in_review = with the carrier vetting team; verified = attach numbers; rejected = fix and PATCH to resubmit; suspended = an infringement claim is open; expired = the yearly verification lapsed; permanently_rejected = terminal.

reviewNotestring nullable

The open change request, as text.

emailVerifiedAtstring date-time nullable
submittedAtstring date-time nullable
verifiedAtstring date-time nullable
expiringAtstring date-time nullable

Verification lasts one year; Zernio resubmits 30 days before this date.

createdAtstring date-time nullable
updatedAtstring date-time nullable

Changes

Changed in 2 of the 61 revisions of this API.2