Subscribers

Update a subscriber

Updates profile fields, status, custom fields, tags, or sequence assignments for one subscriber. Fields omitted from the request stay unchanged. Blank optional custom field values also leave saved values unchanged, and filled-in invalid values are rejected.

patch/v1/subscribers/{subscriber_id}

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/subscribers/{subscriber_id}
  • Auth: HTTP bearer

Path parameters

subscriber_idstring required

The subscriber identifier.

Request body

emailstring email
namestring
countrystring nullable

Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.

subscribed_onstring

Subscriber-local subscription date in YYYY-MM-DD format.

custom_fieldsobject

Custom field values keyed by custom field ID. For Multi Select fields, send an array of option names or a comma-separated string. Blank optional values leave saved values unchanged, and filled-in invalid values are rejected.

Example request

{
  "name": "Ada Lovelace",
  "country": "DE",
  "custom_fields": {
    "cf_company": "Analytical Engines"
  }
}

Response

Successful response

Changes

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