Reply to a change request (POST /v1/sms/registrations/{id}/respond)

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

notestring
Up to 2000 characters.
filesarray of string
Up to 5 items.
requestIdstring
answersarray of object
Up to 20 items.
- pointIdstringrequired
- textstring
  Up to 2000 characters.
- urlstring (URL)
- filesarray of string
  Up to 5 items.

Example

curl -X POST "https://api.pozy.ai/v1/sms/registrations/6bfebd43ddc270f6d2c56fc5/respond" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "string",
  "files": [
    "string"
  ],
  "requestId": "62281f30b62a8870b34602a4",
  "answers": [
    {
      "pointId": "6c6fb5b5b7fd19c8e884d220"
    }
  ]
}'

const res = await fetch("https://api.pozy.ai/v1/sms/registrations/6bfebd43ddc270f6d2c56fc5/respond", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    note: "string",
    files: [
      "string"
    ],
    requestId: "62281f30b62a8870b34602a4",
    answers: [
      {
        pointId: "6c6fb5b5b7fd19c8e884d220"
      }
    ]
  }),
});
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/sms/registrations/6bfebd43ddc270f6d2c56fc5/respond",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "note": "string",
        "files": [
            "string",
        ],
        "requestId": "62281f30b62a8870b34602a4",
        "answers": [
            {
                "pointId": "6c6fb5b5b7fd19c8e884d220",
            },
        ],
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

statusstring
One of requested, rejected.

200 response

{
  "status": "requested"
}

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.