Skip to main content
PATCH
/
v1
/
campaigns
/
{id}
Update Campaign
curl --request PATCH \
  --url https://api.example.com/v1/campaigns/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "daily_send_limit": 123,
  "delay_between_emails": 123,
  "sending_timezone": "<string>",
  "send_on_weekends": true,
  "track_opens": true,
  "track_clicks": true,
  "show_unsubscribe": true
}
'
{
  "data": {
    "campaign": {}
  }
}

Request

Path Parameters

id
string
required
The campaign’s unique ID (UUID)

Headers

Authorization: Bearer wbk_your_api_key_here
Content-Type: application/json
Requires an API key with the campaigns:write permission. All body fields are optional — include only fields you want to change.

Body Parameters

name
string
Campaign name
description
string
Free-form description
daily_send_limit
integer
Maximum emails to send per day (1–500)
delay_between_emails
integer
Seconds to wait between sends within a day (min 30)
sending_timezone
string
IANA timezone (e.g., Europe/Berlin, America/New_York)
send_on_weekends
boolean
Whether sends are allowed on Saturday and Sunday
track_opens
boolean
Enable open tracking
track_clicks
boolean
Enable click tracking
show_unsubscribe
boolean
Append unsubscribe footer (recommended; required in some jurisdictions)

Response

data
object
curl -X PATCH https://data.leadlex.com/functions/v1/api-gateway/v1/campaigns/cmp_abc123 \
  -H "Authorization: Bearer wbk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "daily_send_limit": 75,
    "send_on_weekends": false
  }'

Example Response

{
  "data": {
    "campaign": {
      "id": "cmp_abc123",
      "name": "Q2 GC Outreach",
      "daily_send_limit": 75,
      "send_on_weekends": false,
      "updated_at": "2026-04-17T14:30:00Z"
    }
  }
}

Errors

StatusCodeDescription
400invalid_timezonesending_timezone is not a valid IANA zone
400invalid_send_limitdaily_send_limit out of range (1–500)
401invalid_keyInvalid or expired API key
403insufficient_permissionsMissing campaigns:write permission
404campaign_not_foundNo campaign with this ID
429rate_limitedRate limit exceeded