Phone & voice · Branded Calling
Creates a caller identity share link.
POST
https://api.pozy.ai/v1/branded-calling/shareNot available yetshareBrandedCallingIdentityForm
Guide: Branded calling
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
This endpoint is not available yet. Calls return 403 feature_not_available.
Request body
application/json, optional
enterpriseIdstringidentityIdstring
Example
curl -X POST "https://api.pozy.ai/v1/branded-calling/share" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enterpriseId": "66496a86752378ad82057ff6",
"identityId": "677d7bec579c1ba703d97ae7"
}'const res = await fetch("https://api.pozy.ai/v1/branded-calling/share", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
enterpriseId: "66496a86752378ad82057ff6",
identityId: "677d7bec579c1ba703d97ae7"
}),
});
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.post(
"https://api.pozy.ai/v1/branded-calling/share",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"enterpriseId": "66496a86752378ad82057ff6",
"identityId": "677d7bec579c1ba703d97ae7",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
urlstringexpiresAtstring (date-time)
200 response
{
"url": "https://pozy.ai/media/example-1.jpg",
"expiresAt": "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. |
| 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 businessesPOSTRegister a business for Branded CallingGETGet a registered businessDELDelete a registered businessGETList pre-approved call reasonsGETList caller identitiesPOSTCreate a caller identityPOSTDry-run a caller identity before creating itGETGet a caller identityPATCHEdit or resubmit a caller identityDELDelete a caller identityPOSTResend the authorizer's codePOSTConfirm the authorizer's codeGETList the numbers on a caller identityPOSTAttach numbers to a verified identityDELDetach numbers from an identity