Skip to main content
PUT
Switch one of the Larm store's messages on or off (`enabled`), or set which order statuses an order update speaks about (`statuses`: completed, cancelled, refunded, each true or false); answers whether it was on before.

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
Tawked-Approval
string<uuid>

The id of an approval its person approved (approvals.show answers approved): the same request then runs, once.

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})$
kind
string
required

A store notification's kind, in snake_case (order_shipped); list them with integrations.larm.show.

Pattern: ^(?:[a-z_]+)$

Body

application/json
enabled
boolean
statuses
object

Response

Done.

data
object
required