Update the a subscriber.
Response format | JSON |
---|---|
Requires authentication? | Yes |
phone_number optional | The customer's phone number. |
---|---|
email_address optional | The customer's email address. |
external_user_id optional | External ID for the customer. |
inboxed optional | A boolean to toggle if subscriber is in the support queue, sets |
status optional | The customer's subscription status - subscribed, unsubscribed, or unconfirmed. Please make sure you have the legal right to re-subscribe a previously unsubscribed subscriber. |
curl -X PUT \
-u '[SID]:[TOKEN]' \
-H 'Content-Type: application/json' \
'https://api.essential.to/v2/account/subscribers/daBoeXvpfadRPgyYaaZJpw' \
-d '{"email_address":"jane.doe@company.com"}'
# Sample response
{
"phone_number": "5009998080",
"status": "subscribed",
"subscribed_at": "2017-01-25T21:43:04.000Z",
"unsubscribed_at": null,
"created_at": "2017-01-25T21:43:04.000Z",
"updated_at": "2017-01-25T21:43:04.000Z",
"carrier": "AT&T Wireless",
"carrier_updated_at": "2017-01-25T21:43:04.000Z",
"added_to_inbox_at": null,
"facebook_id": null,
"email_address": "jane.doe@company.com",
"external_user_id": null,
"sid": "daBoeXvpfadRPgyYaaZJpw",
"account_sid": "p03Gjl8Uzn0RkZSpHXHnrw",
"channel_sid": "p03Gjl8Uzn0RkZSpHXHnrw",
"transport_sid": "p03Gjl8Uzn0RkZSpHXHnrw"
}
Python coming soon.
Node coming soon.