SEsendfox
Lists

Update a contact list

Changed on
patch/lists/{id}

Request

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

Request body

namestring
public_descriptionstring nullable

The name subscribers see on the unsubscribe and preference pages. Blank uses the list's own name.

subscriber_descriptionstring nullable

What subscribers can expect from this list, shown below its name on those pages. Blank clears it.

Response

List updated successfully

idinteger
namestring required
user_idinteger
subscribed_contacts_countinteger

Members who can still be mailed from this list. Excludes anyone who unsubscribed from the list itself as well as anyone who unsubscribed from the account.

unsubscribed_contacts_countinteger

Members who have stopped this list, by either the account-wide unsubscribe or this list's own. A hard bounce is included, because bouncing sets the account-wide flag. These two counts do not sum to total membership: an address flagged invalid is in neither.

public_descriptionstring nullable

The name subscribers see for this list on the unsubscribe and preference pages, or null to show the list's own name.

subscriber_descriptionstring nullable

What subscribers can expect from this list, shown below its name on the unsubscribe and preference pages. Returned by GET /lists/{id} and PATCH /lists/{id} only, not when lists are listed or embedded in a contact.

average_email_open_percentnumber float
average_email_click_percentnumber float
created_atstring date-time
updated_atstring date-time

Changes

  • ae5d5ba1d502Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 1c85e046fea0Revision changes
    • 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