Remove Contact from Audience

Remove a contact from one static audience, identified by cnvContactId, userId, or email, in that order. Does not delete the contact, update fields, change subscription status, or remove other audience memberships. Returns success if the contact or membership is already absent. Requires audience edit permission.

delete/v2/audiences/{audienceId}/contacts

Request

Base URL
https://pub-api.conversion.ai/api
Auth
- API key in header X-API-Key
- or API key in query parameter api_key

Path parameters

audienceIdstring uuid required

The ID of the static audience to remove the contact from.

Request body

emailstring email

The contact's email address. At least one of cnvContactId, userId, or email is required.

cnvContactIdstring uuid

The Conversion contact ID. At least one of cnvContactId, userId, or email is required.

userIdstring

An external user identifier for the contact. At least one of cnvContactId, userId, or email is required.

Example request

{
  "email": "jane@example.com",
  "cnvContactId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "userId": "user_12345"
}

Response

Membership is absent, including if the contact was not found.

Changes

No recorded changes to this operation across all 1 revision of this API.