API ReferenceSubscriptionsUpdate Subscription

Update Subscription

Idempotently add a contact to a subscription group list or update their subscription status/details. This endpoint returns 201 Created if a new subscription is created, and 200 OK if an existing subscription is updated. If the contact does not exist globally, it returns 404 CONTACT_NOT_FOUND.

PUThttps://wapi.simplysend.email/web-setup/contacts/subscription-groups/{subscriptionGroupId}/subscriptions/{identifier}

Parameters

subscriptionGroupIdRequired

string

The unique ID of the subscription group (path parameter).

identifierRequired

string

The subscriber's contact identifier (must be a secure hashed channel identifier like 'email_<md5>' or 'phone_<md5>') (path parameter).

isActive

boolean

Active status of subscription (true/false).

consentMethod

string

Optional updated consent method to sync to global contact profile. Valid values: 'double_opt_in', 'single_opt_in', 'imported', 'web_form', 'implicit_api', 'other'.

consentDetails

string

Optional updated consent details or audit notes to sync to global contact profile.

RequestPUT

curl -X PUT https://wapi.simplysend.email/web-setup/contacts/subscription-groups/newsletter_list/subscriptions/email_4832981775432a1383848b8137350438 \
  -H "X-Api-Key: your_api_key" \
  -H "X-Id: your_account_id" \
  -H "Content-Type: application/json" \
  -d '{
  "isActive": false,
  "consentMethod": "web_form",
  "consentDetails": "Footer newsletter signup form updated"
}'

Response

{
  "success": true,
  "data": {
    "message": "Subscriber added successfully",
    "subscriber": {
      "subscriptionGroupId": "newsletter_list",
      "contactIdentifier": "email_4832981775432a1383848b8137350438",
      "email": "[email protected]",
      "userId": "e4f85498-b081-70f3-7d20-65a8697259c8",
      "isActive": true,
      "joinedAt": "2026-03-02T07:30:06.337Z",
      "source": "api",
      "consentMethod": "web_form",
      "consentDetails": "Footer newsletter signup form updated"
    }
  }
}