Update a subscriber

PUT

/api/subscribers/{id}

Only the fields you send are changed. Only the customFields keys you send
are changed; the others keep their values. Send null to clear one.
When tags is sent it replaces the subscriber's tag set; when it is omitted
the tags are kept.

Request

Authorization

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Subscriber updated

Bodyapplication/json

🟠409Unauthorized

🟠400InvalidCustomFields

🟠401Unauthorized

🟠403EmailNotVerified

Request Example

Shell

JavaScript

Java

Swift

cURL

Update a single custom fieldClear a custom field value

curl --location --request PUT 'https://api.maildesk.io/api/subscribers/' \
--header 'Content-Type: application/json' \
--data '{
    "customFields": {
        "latest_destination": "Lisbon"
    }
}'

Response Example

200 - Example 1

{
    "subscriber": {
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "email": "john.doe@yourcompany.com",
        "firstName": "John",
        "lastName": "Doe",
        "status": "CONFIRMED",
        "tags": [
            "Newsletter"
        ],
        "customFields": {
            "latest_destination": "Lisbon",
            "trips": 3
        },
        "createdAt": "2026-10-07T10:00:00.000Z"
    }
}

Modified at 2026-10-08 06:32:39

Delete a subscriber

Get all subscribers