SEsendfox
Lists

Unsubscribe a contact from one list

Changed on

Stops this one list for this one contact. Their other lists and their account-wide status are untouched, which is what distinguishes this from PATCH /unsubscribe — that endpoint is account-wide and is unchanged. Idempotent. Repeating the request returns the original timestamp rather than moving it, so a retry never loses the date the person actually asked. The opt-out is recorded durably, so it survives the contact being removed from the list and added back: re-adding them does not start sending again. There is no matching resubscribe endpoint. Taking consent away on someone's behalf is safe for an integration to do; handing it back is not.

patch/lists/{list_id}/unsubscribe

Request

  • Base URL
    https://api.sendfox.com
  • Auth
    OAuth 2
    Authorization codehttps://sendfox.com/oauth/authorize
    Token URLhttps://sendfox.com/oauth/token

Request body

emailstring email required

Email address of a contact already on this list

Response

The contact, with the same two extra fields the unsubscribes list returns.

idinteger
emailstring email required
first_namestring
last_namestring
ip_addressstring
unsubscribed_atstring date-time nullable
bounced_atstring date-time nullable

When this address hard bounced. A hard bounce also sets unsubscribed_at. If unsubscribed_at is null, or far from this date, the bounce isn't what's stopping their email; they were resubscribed or opted out separately.

bounce_paused_atstring date-time nullable

When this contact was last paused for repeated bounces. Can remain set after the pause has ended; read bounce_paused_until to tell.

bounce_paused_untilstring date-time nullable

When the current repeated-bounce pause ends. Null if the contact isn't paused, or has since unsubscribed or become invalid, since no retry is coming.

invalid_atstring date-time nullable

When this address was found to be invalid. It isn't mailed while this is set.

created_atstring date-time
updated_atstring date-time
list_unsubscribed_atstring date-time

When they stopped this list.

unsubscribed_scope'list' | 'account' | 'both'

Changes

  • ae5d5ba1d502Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 1c85e046fea0Revision changes
    • info

      endpoint added