Manage Individual Subscribers
Show a subscriber
Returns the attributes of the requested subscriber.
GET https://go.smartrmail.com/api/v1/subscribers/:email_or_phone_or_uid
Parameters
:email_or_phone_or_uid - The email address, phone number, or UID of the requested subscriber.
Expected response
json
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "id": "asdf", "email": "[email protected]", "phone": "+61478940895", "first_name": "van", "last_name": "halen", "unsubscribed_at": null, "complained": false, "delivered_count": 100, "opened_count": 100, "clicked_count": 100, "joined_at": "2013-03-11 01:00:00 UTC", "subscribed": true, "custom_fields": [ { "id": 1, "field_name": "Age", "value": "20", "value_type": "text" }, { "id": 2, "field_name": "City", "value": "Lisbon", "value_type": "text" } ] }Update a subscriber
Updates attributes of the requested subscriber.
PUT https://go.smartrmail.com/api/v1/subscribers/:email_or_phone_or_uid
Parameters
:email_or_phone_or_uid - The email address, phone number, or UID of the requested subscriber.
Custom field types
"text", "number", "date", "birthday"
Important: for birthday-type fields, always use YYYY-MM-DD format (e.g. 1990-06-10). Other formats will save without an API error, but only YYYY-MM-DD is correctly parsed by birthday-dependent features like segments, merge tags, and birthday automations.
Note: date-type fields are always returned in full ISO 8601 format (e.g. 2021-01-25T00:00:00.000Z) in responses, regardless of the plain-date format you submit (e.g. 2021-01-25).
Expected request
json
Accept: application/json Authorization: token YOUR_API_TOKEN Content-Type: application/json { "email": "[email protected]", "first_name": "john", "phone": "+61478940895", "last_name": "bar", "subscribed": true, "custom_fields": [ { "field_name": "Age", "value": "20", "value_type": "text" }, { "field_name": "City", "value": "Lisbon", "value_type": "text" }, { "field_name": "Loyalty Number", "value": 123456789, "value_type": "number" }, { "field_name": "Wedding Date", "value": "2021-01-25", "value_type": "date" }, { "field_name": "Birthday", "value": "1990-06-10", "value_type": "birthday" } ] }Expected response
json
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "id": "asdf", "email": "[email protected]", "phone": "+61478940895", "first_name": "john", "last_name": "bar", "unsubscribed_at": null, "complained": false, "delivered_count": 100, "opened_count": 100, "clicked_count": 100, "joined_at": "2013-03-11 01:00:00 UTC", "subscribed": true, "custom_fields": [ { "id": 1, "field_name": "Age", "value": "20", "value_type": "text" }, { "id": 2, "field_name": "City", "value": "Lisbon", "value_type": "text" }, { "id": 3, "field_name": "Loyalty Number", "value": 123456789, "value_type": "number" }, { "id": 4, "field_name": "Wedding Date", "value": "2021-01-25T00:00:00.000Z", "value_type": "date" }, { "id": 5, "field_name": "Birthday", "value": "1990-06-10", "value_type": "birthday" } ] }Unsubscribe a subscriber
Unsubscribes the requested subscriber. No request body is needed.
POST https://go.smartrmail.com/api/v1/subscribers/:email_or_phone_or_uid/unsubscribe
Parameters
:email_or_phone_or_uid - The email address, phone number, or UID of the requested subscriber.
Note: this only changes the subscriber's subscription status — it never affects their custom field data.
Expected response
json
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "id": "asdf", "email": "[email protected]", "phone": "+61478940895", "first_name": "van", "last_name": "halen", "unsubscribed_at": "2013-03-11 01:00:00 UTC", "complained": false, "delivered_count": 100, "opened_count": 100, "clicked_count": 100, "joined_at": "2013-03-11 01:00:00 UTC", "subscribed": false, "custom_fields": [ { "id": 1, "field_name": "Age", "value": "20", "value_type": "text" } ] }Resubscribe a subscriber
Resubscribes the requested subscriber. No request body is needed.
POST https://go.smartrmail.com/api/v1/subscribers/:email_or_phone_or_uid/resubscribe
Parameters
:email_or_phone_or_uid - The email address, phone number, or UID of the requested subscriber.
Important: this only reactivates the subscriber's subscription status — it does not retrigger any list-triggered welcome automations, and it never affects their custom field data. If you need a welcome sequence to fire for a resubscribed contact, that isn't something this endpoint does; you'll need to handle that separately.
Expected response
json
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "id": "asdf", "email": "[email protected]", "phone": "+61478940895", "first_name": "van", "last_name": "halen", "unsubscribed_at": null, "complained": false, "delivered_count": 100, "opened_count": 100, "clicked_count": 100, "joined_at": "2013-03-11 01:00:00 UTC", "subscribed": true, "custom_fields": [ { "id": 1, "field_name": "Age", "value": "20", "value_type": "text" } ] }