Messaging · iMessage

Remove a participant from an iMessage group

Removes a participant from an iMessage group.

DELETEhttps://api.pozy.ai/v1/imessage/groups/{conversationId}/participants
removeImessageGroupParticipant

Guide: iMessage

Request

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

Path parameters

NameTypeNotes
conversationIdrequiredstring

Query parameters

NameTypeNotes
accountIdrequiredstring
contactrequiredstring

Example

curl -X DELETE "https://api.pozy.ai/v1/imessage/groups/6e525f3820fc636aa96d2ee9/participants?accountId=696e0b682d0a31188e7a2ba9&contact=string" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successboolean
  • conversationIdstring
  • contactstring
200 response
{
  "success": true,
  "conversationId": "6e525f3820fc636aa96d2ee9",
  "contact": "string"
}

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