Subscription status

JSON

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "channel": "email",
    "db_id": 20,
    "email": "example@example.org",
    "priority": 4,
    "profile_id": "5a5b91d769d4265b958b9acb",
    "resource_id": 3,
    "status": "suspended"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <channel>email</channel>
  <db_id>20</db_id>
  <email>example@example.org</email>
  <priority>4</priority>
  <profile_id>5a5b91d769d4265b958b9acb</profile_id>
  <resource_id>3</resource_id>
  <status>suspended</status>
</xml>

Object values

The status parameter overwrites the status of the subscription. It is recommended that you pass it only when you need to update the status.

Both word and numeric values are valid.

Word value	Description	Number value
subscribed	Ready for messaging	0
unsubscribed	Unsubscribed	1
complained	Reported spam	2
hardbounced	Hard bounce, email probably invalid	3
unconfirmed	Subscription unconfirmed	4
suspended	Temporarily unsubscribed	5
invalid	Invalid for a variety of reasons	6