Phone & voice · Branded Calling

Edit or resubmit a caller identity

Edits or resubmits a caller identity. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/branded-calling/identities/{id}

updateBrandedCallingIdentity

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`id`required	string

Request body

application/json, required

displayNamestring
1 to 35 characters.
callReasonsarray of string
At least 1 item. Up to 10 items. Each item: up to 64 characters.
logoUrlstring
authorizerobject
- namestringrequired
  Up to 255 characters.
- emailstring (email)required
referencesobject
- businessarray of objectrequired
  At least 2 items. Up to 2 items.
  7 child fields
  - fullNamestringrequired
    Up to 255 characters.
  - jobTitlestring
    Up to 255 characters.
  - organizationstring
    Up to 255 characters.
  - relationshipToRegistrantstring
    Up to 255 characters.
  - phoneNumberstringrequired
  - emailstring (email)required
  - timezonestringrequired
- financialobjectrequired
  7 child fields
  - fullNamestringrequired
    Up to 255 characters.
  - jobTitlestring
    Up to 255 characters.
  - organizationstring
    Up to 255 characters.
  - relationshipToRegistrantstring
    Up to 255 characters.
  - phoneNumberstringrequired
  - emailstring (email)required
  - timezonestringrequired
reviewAnswersmap of object
Keys are free-form; each value has these fields.
- textstring
- urlstring (URL)
reviewNotestring
Up to 4000 characters.

Example

curl -X PATCH "https://api.pozy.ai/v1/branded-calling/identities/6bfebd43ddc270f6d2c56fc5" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Acme",
  "callReasons": [
    "string"
  ],
  "logoUrl": "https://pozy.ai/media/example-1.jpg",
  "authorizer": {
    "name": "Acme",
    "email": "alex@example.com"
  }
}'

const res = await fetch("https://api.pozy.ai/v1/branded-calling/identities/6bfebd43ddc270f6d2c56fc5", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    displayName: "Acme",
    callReasons: [
      "string"
    ],
    logoUrl: "https://pozy.ai/media/example-1.jpg",
    authorizer: {
      name: "Acme",
      email: "alex@example.com"
    }
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.patch(
    "https://api.pozy.ai/v1/branded-calling/identities/6bfebd43ddc270f6d2c56fc5",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "displayName": "Acme",
        "callReasons": [
            "string",
        ],
        "logoUrl": "https://pozy.ai/media/example-1.jpg",
        "authorizer": {
            "name": "Acme",
            "email": "alex@example.com",
        },
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

idstring
enterpriseIdstring
displayNamestring
Up to 35 characters.
callReasonsarray of string
Each item: up to 64 characters.
callReasonsPreApprovedboolean
logoUrlstring
Can be null.
authorizerobject
- namestring
- emailstring (email)
referencesobject
- businessarray of objectrequired
  At least 2 items. Up to 2 items.
  7 child fields
  - fullNamestringrequired
    Up to 255 characters.
  - jobTitlestring
    Up to 255 characters.
  - organizationstring
    Up to 255 characters.
  - relationshipToRegistrantstring
    Up to 255 characters.
  - phoneNumberstringrequired
  - emailstring (email)required
  - timezonestringrequired
- financialobjectrequired
  7 child fields
  - fullNamestringrequired
    Up to 255 characters.
  - jobTitlestring
    Up to 255 characters.
  - organizationstring
    Up to 255 characters.
  - relationshipToRegistrantstring
    Up to 255 characters.
  - phoneNumberstringrequired
  - emailstring (email)required
  - timezonestringrequired
statusstring
One of requested, changes_requested, rejected, pending_email_verification, in_review, verified, suspended, expired, permanently_rejected.
rejectionReasonsarray of object
- codestring
- titlestring
- detailstring
- messagestring
  Can be null.
reviewNotestring
Can be null.
reviewRequestobject
Can be null.
- idstring
- introstring
- pointsarray of object
  4 child fields
  - idstring
  - titlestring
  - detailstring
  - answerstring
    One of text, link, file, link_or_file.
emailVerifiedAtstring (date-time)
Can be null.
submittedAtstring (date-time)
Can be null.
verifiedAtstring (date-time)
Can be null.
expiringAtstring (date-time)
Can be null.
numbersarray of object
- phoneNumberIdstring
- phoneNumberstring
- statusstring
  One of submitted, in_review, verified, unsuccessful, suspended, expired, permanently_rejected.
- rejectionReasonobject
  Can be null.
  4 child fields
  - codestring
  - titlestring
  - detailstring
  - messagestring
    Can be null.
- verifiedAtstring (date-time)
  Can be null.
- addedAtstring (date-time)
  Can be null.
createdAtstring (date-time)
Can be null.
updatedAtstring (date-time)
Can be null.

200 response

{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "enterpriseId": "66496a86752378ad82057ff6",
  "displayName": "Acme",
  "callReasons": [
    "string"
  ],
  "callReasonsPreApproved": true,
  "logoUrl": "https://pozy.ai/media/example-1.jpg",
  "authorizer": {
    "name": "Acme",
    "email": "alex@example.com"
  },
  "references": {
    "business": [
      {
        "fullName": "Acme",
        "jobTitle": "string",
        "organization": "string",
        "relationshipToRegistrant": "string",
        "phoneNumber": "+14155550123",
        "email": "alex@example.com",
        "timezone": "America/New_York"
      }
    ],
    "financial": {
      "fullName": "Acme",
      "jobTitle": "string",
      "organization": "string",
      "relationshipToRegistrant": "string",
      "phoneNumber": "+14155550123",
      "email": "alex@example.com",
      "timezone": "America/New_York"
    }
  },
  "status": "requested",
  "rejectionReasons": [
    {
      "code": "string",
      "title": "Launch day",
      "detail": "string",
      "message": "Hello from Pozy"
    }
  ],
  "reviewNote": "string",
  "reviewRequest": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "intro": "string",
    "points": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "title": "Launch day",
        "detail": "string",
        "answer": "text"
      }
    ]
  },
  "emailVerifiedAt": "2026-10-02T09:00:00.000Z",
  "submittedAt": "2026-10-02T09:00:00.000Z",
  "verifiedAt": "2026-10-02T09:00:00.000Z",
  "expiringAt": "2026-10-02T09:00:00.000Z",
  "numbers": [
    {
      "phoneNumberId": "698fba0989716df44adb771f",
      "phoneNumber": "+14155550123",
      "status": "submitted",
      "rejectionReason": {
        "code": "string",
        "title": "Launch day",
        "detail": "string",
        "message": "Hello from Pozy"
      },
      "verifiedAt": "2026-10-02T09:00:00.000Z",
      "addedAt": "2026-10-02T09:00:00.000Z"
    }
  ],
  "createdAt": "2026-10-02T09:00:00.000Z",
  "updatedAt": "2026-10-02T09:00:00.000Z"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Branded Calling

GETList registered businesses POSTRegister a business for Branded Calling GETGet a registered business DELDelete a registered business POSTCreate a caller identity share link GETList pre-approved call reasons GETList caller identities POSTCreate a caller identity POSTDry-run a caller identity before creating it GETGet a caller identity DELDelete a caller identity POSTResend the authorizer's code POSTConfirm the authorizer's code GETList the numbers on a caller identity POSTAttach numbers to a verified identity DELDetach numbers from an identity