Messaging · SMS

Create a registration share link

Creates a registration share link.

POSThttps://api.pozy.ai/v1/sms/registrations/share
Not available yetshareSmsRegistration

Guides: US 10DLC registration, SMS

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, required

  • numberIdstringrequired

Example

curl -X POST "https://api.pozy.ai/v1/sms/registrations/share" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "numberId": "6b7945542dc9bbde362239b3"
}'

Response

200 on success

  • urlstring
  • expiresAtstring (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:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in SMS