Messaging · iMessage

Remove an iMessage sandbox contact

Removes an iMessage sandbox contact.

DELETEhttps://api.pozy.ai/v1/imessage/sandbox/contacts/{contactId}
removeImessageSandboxContact

Guide: iMessage

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Authentication

Path parameters

NameTypeNotes
contactIdrequiredstring

Example

curl -X DELETE "https://api.pozy.ai/v1/imessage/sandbox/contacts/642d31f43531ce7d44aa5013" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successboolean
200 response
{
  "success": true
}

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.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in iMessage