Skip to main content
PUT
/
subscribers
/
{id}
Update a subscriber
curl --request PUT \
  --url https://app.letterbucket.com/api/v1/subscribers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "name": "New Name"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}
At least one field must be provided. If status is omitted, the current status does not change. Setting status to pending triggers a confirmation email.

Authorizations

​
Authorization
string
header
required

Your API key, sent as Authorization: Bearer sk_....

Path Parameters

​
id
string<uuid>
required

Subscriber ID (UUID).

Body

application/json

At least one field must be provided.

​
email
string<email>
Maximum string length: 254
Example:

"[email protected]"

​
name
string | null
Maximum string length: 255
Example:

"New Name"

​
status
enum<string>
Available options:
active,
pending

Response

The updated subscriber.

​
success
boolean
​
data
object