Do Not Contact

Add entries to Do Not Contact list

Add one or multiple email addresses and domains to your Do Not Contact (suppression) list. Supports 1-2000 entries per request. Duplicates are skipped automatically.

post/v3/user-api/do-not-contacts

Request

  • Base URL
    https://api.nureply.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-personal-api-key

Headers

x-personal-api-keystring required

API Key from Dashboard

Request body

Example request

{
  "entries": [
    {
      "value": "user@example.com",
      "type": "email",
      "reason": "unsubscribe",
      "notes": "Requested via email on 2024-01-15"
    }
  ]
}

Response

messagestring required

Example response

{
  "message": "DNC entries processed successfully",
  "data": {
    "added": 50,
    "duplicates": 5,
    "invalid": 2,
    "summary": {
      "totalProvided": 57,
      "added": 50,
      "duplicates": 5,
      "invalid": 2
    },
    "addedEntries": [
      {
        "value": "user@example.com",
        "type": "email",
        "reason": "unsubscribe",
        "_id": "653a2b0bf5444e11e5cdd1ce",
        "createdAt": "2023-10-26T11:11:25.365Z"
      }
    ],
    "duplicateValues": [
      "existing@example.com"
    ],
    "invalidValues": [
      "invalid-email"
    ]
  }
}

Changes

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