ITiterable
lists

Remove users from a list

Remove specific users from a list.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

post/api/lists/unsubscribe

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

campaignIdinteger

attribute unsubscribe to a campaign

channelUnsubscribeboolean

Unsubscribe email from list's associated channel - essentially a global unsubscribe. (default: false)

listIdinteger required

Response

successful operation

createdFieldsstring[]

Fields that were created because <code>createNewFields</code> was <code>true</code> or <code>createNewFields</code> was not set and the project is configured to add unrecognized user profile fields.

failCountinteger required

Number of user profiles that could not be updated. See <code>failedUpdates</code> for more details.

filteredOutFieldsstring[]

Fields that were dropped because <code>createNewFields</code> was <code>false</code> or <code>createNewFields</code> was not set and the project is configured to drop unrecognized user profile fields.

invalidEmailsstring[]

<code>email</code> addresses of users that failed to update. This field is deprecated — use <code>failedUpdates</code> instead.

invalidUserIdsstring[]

<code>userId</code> values of users that failed to update. This field is deprecated — use <code>failedUpdates</code> instead.

successCountinteger required

Number of user profiles that were updated in response to the request.

Changes

No recorded changes to this operation across all 4 revisions of this API.