Update campaign

PATCH

/api/v1/campaigns/{id}

Update campaign settings including name, description, schedule config, stop-on-reply, first-message buttons, scheduled start time, and variant optimization settings.

Request

Authorization

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

Default Response

This response does not have a body.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/campaigns/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "stopOnReply": true,
    "scheduleConfig": {
        "timezone": "string",
        "startTime": "string",
        "endTime": "string",
        "workingDays": [
            0
        ],
        "minDelayMs": 0,
        "maxDelayMs": 0
    },
    "firstMessageButtons": {
        "enabled": true,
        "interestedLabel": "string",
        "notInterestedLabel": "string",
        "blockLabel": "string",
        "buttonStepOrder": 0
    },
    "scheduledStartTime": "string",
    "scheduledTimezone": "string",
    "variantOptimization": {
        "enabled": true,
        "optimizationMetric": "replyRate",
        "minimumSendsPerVariant": 1,
        "minimumDays": 1,
        "keepMinimumVariants": 1
    }
}'

Modified at 2026-03-09 12:24:48

Get campaign by ID

Delete campaign