DoNotContact v1.2

Subscribers with an email address, domain name or MSISDN matching an entry on your 'Do Not Contact List' cannot be contacted.

What can I do with doNotContact?

DoNotContact represents a supression list. This list is checked every time a subscriber is added or imported.

  • You cannot create a new subscriber if the email or msisdn provided matches a contactdata value.
  • Find any resources affecting a new subscriber by filtering contactdata according to their email or msisdn.
  • Use the contactdata attribute to block all contact to a particular domain.
  • You cannot modify a doNotContact resource once it has been created - try issuing DELETE and re-POST instead.

Any subscriber who chooses to unsubscribe through the Sign-Up.to platform will be automatically added to your doNotContact list.

GET /doNotContact or /doNotContact/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the resource.
contactdata
stringYesYesAn email address, domain name or MSISDN (see definition).
cdate
decimalNoYesCreation timestamp.

HEAD /doNotContact or /doNotContact/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the resource.
contactdata
stringOptionalAn email address, domain name or MSISDN (see definition).

POST /doNotContact

AttributeTypePresenceDescription
contactdata
stringRequiredAn email address, domain name or MSISDN (see definition).

A DELETE will be issued on any subscribers with attributes matching the new contactdata value.

PUT /doNotContact or /doNotContact/:id

This method is not supported.

DELETE /doNotContact or /doNotContact/:id

AttributeTypePresenceDescription
id
intOptional*Unique ID of the resource.
contactdata
stringOptional*An email address, domain name or MSISDN (see definition).

*Arguments are mutually exclusive.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":             123456,
    "contactdata":    "somebody@example.com",
    "cdate":          1317259641
}