Contacts

Opt a contact out

POST/contacts/{phone}/opt-outScope contacts:write

Marks the contact as opted out. Broadcasts and other marketing sends skip them from then on.

Path parameters

phonestringrequired
The contact's phone number with country code. Anything other than digits is ignored, so +91 98765 43210 works.

Errors

Status	Code	When
404	NOT_FOUND	No contact with that number.

Plus the errors any endpoint can return, such as a missing key or scope. See Errors.

Request

# macOS, Linux or Git Bash, with WAMAFY_API_KEY set. The quoting does not work in Windows cmd or PowerShell.
curl -X POST "https://api.wamafy.com/api/v1/public/contacts/919876543210/opt-out" \
  -H "Authorization: Bearer $WAMAFY_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "id": "9d3f6b2a-4e1c-4a8b-9f0d-2c7e5a1b3d64",
    "phone": "919876543210",
    "name": "Priya Sharma",
    "firstName": "Priya",
    "lastName": "Sharma",
    "company": "Acme Retail",
    "language": "en",
    "email": "priya@example.com",
    "tags": [
      "vip"
    ],
    "status": "opted_out",
    "consentStatus": "opted_out",
    "source": "api",
    "customFields": {
      "city": "Mumbai"
    },
    "createdAt": "2026-09-02T08:15:00.000Z",
    "updatedAt": "2026-10-07T10:00:00.000Z"
  }
}

Base URL https://api.wamafy.com/api/v1/public