Ads · Ad Audiences

Remove users from audience

Removes users from audience. Works with Meta Ads and Reddit Ads.

DELETEhttps://api.pozy.ai/v1/ads/audiences/{audienceId}/users
Facebook and Instagram and RedditremoveUsersFromAdAudience

Guide: Audiences

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
audienceIdrequiredstring

Request body

application/json, required

  • usersarray of objectrequired

    At least 1 item. Up to 10000 items.

    • emailstring (email)
    • phonestring

Example

curl -X DELETE "https://api.pozy.ai/v1/ads/audiences/6cb6496d2ca0017ff720f51f/users" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "users": [
    {
      "email": "alex@example.com",
      "phone": "+14155550123"
    }
  ]
}'

Response

200 on success

  • messagestring
  • numReceivedinteger
  • numInvalidinteger
  • invalidEntrySamplesmap of string
200 response
{
  "message": "Hello from Pozy",
  "numReceived": 1,
  "numInvalid": 1,
  "invalidEntrySamples": {
    "key": "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 Ad Audiences