Skip to main content
PUT
Change the campaign settings: the cap (`fatigue_max` 1 to 7 and `fatigue_days` 1 to 30, both together) and/or `campaign_message_webhooks` (true sends each campaign message's statuses to the webhook endpoints). Answers the settings.

Authorizations

Authorization
string
header
required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key
string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128

Path Parameters

application
string
required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

application/json
campaign_message_webhooks
boolean
fatigue_days
integer

Required with fatigue_max.

Required range: 1 <= x <= 30
fatigue_max
integer

Required with fatigue_days.

Required range: 1 <= x <= 7

Response

Done.

data
object
required