ITiterable
subscriptions

Unsubscribe a single user

Unsubscribes a user from the specified subscription group. To enable this API, contact your customer success manager.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

delete/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/user/{userEmail}

Request

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

Path parameters

subscriptionGroupstring required

Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]

subscriptionGroupIdinteger required

Subscription Group Id [Numeric]

userEmailstring required

User's Email [Alphanumeric]

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

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