PATCH/v1/quick-messages/{quick_message_id}beta

Update a quick message

Needs: Send WhatsApp messages; manage templates, quick messages and WhatsApp short links (messaging:write)
Plan: Any plan with API access
Limits: 60 a minute per key
Dry run: Yes — every check runs with ?dry_run=true, nothing changes
Undo: Send the old values back.

Changes only the fields you pass. The type cannot change: delete it and create a new one instead. Only TEXT, IMAGE, VIDEO and DOCUMENT quick messages can be edited here.

Try it

Path

quick_message_idrequired

The quick message id.

Edit as JSON

codeoptionalstring

New shortcut code (unique, no spaces).

titleoptionalstring

New title.

descriptionoptionalstring

A note for your team.

textoptionalstring

The message (`TEXT`), or the caption of a media message.

media_urloptionalstring

Public https URL of a new file (media types).

file_nameoptionalstring

`DOCUMENT`: the file name the customer sees.

visibilityoptionalstring

`private`, `team` or `company`.

team_idoptionalstring

The team, with `visibility: team`.

Idempotency-Keyoptional — made for you if empty

Protects against doing it twice if you retry: a retry with the same key gets the first answer back instead of running again.

Test mode (dry run): nothing will change

Run liveTurns test mode off for this page only. It switches back when you leave the page.

curl -X PATCH 'https://mcp.wa-api.cloud/v1/quick-messages/12?dry_run=true' \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "text": "Thank you for your order, {{contact.name}}!"
}'

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
quick_message_idrequired	string \| integer · path	The quick message id.

Body

Body fields
Field	Type	What it is
code	string	New shortcut code (unique, no spaces).pattern `^\S+$` · 1–60 characters
title	string	New title.1–120 characters
description	string	A note for your team.0–500 characters
text	string	The message (`TEXT`), or the caption of a media message.0–4096 characters
media_url	string	Public https URL of a new file (media types).uri · 0–2000 characters
file_name	string	`DOCUMENT`: the file name the customer sees.0–200 characters
visibility	string	`private`, `team` or `company`.one of: `private`, `team`, `company`
team_id	string	The team, with `visibility: team`.0–20 characters

Headers

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`
Idempotency-Key	header	Any unique string (8–128 characters). A retry with the same key returns the first answer instead of running twice. Kept 24 hours.pattern `^[A-Za-z0-9._:-]+$` · 8–128 characters

Response `200`

The updated quick message.

Response fields
Field	Type	What it is
idrequired	string
coderequired	string or null	Shortcut agents type after "/" in the inbox.
titlerequired	string or null
typerequired	string or null	TEXT, IMAGE, VIDEO, DOCUMENT, TEMPLATE, INTERACTIVE …
textrequired	string or null	Text body, or the media caption.
media_urlrequired	string or null
template_namerequired	string or null
visibilityrequired	string or null
team_idrequired	string or null
favoriterequired	boolean
can_editrequired	boolean
updated_atrequired	string or null
dry_run	boolean	`true` when this was a dry run: every check ran and nothing changed.

Errors

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field.
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	forbidden	The key's user is not allowed to edit this quick message.
403	insufficient_scope	The key does not have the permission this operation needs.
404	not_found	No quick message with this id that the key's user can see.
409	conflict	Also returned while a request with the same Idempotency-Key is still running.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.
504	timeout	The change did not finish in time. Retry with the same Idempotency-Key: it never runs twice.

Examples

Change the wording

Request body

{
  "text": "Thank you for your order, {{contact.name}}!"
}

Response 200

{
  "id": "12",
  "code": "thanks",
  "title": "Thank you",
  "type": "TEXT",
  "text": "Thank you for your order, {{contact.name}}!",
  "media_url": null,
  "template_name": null,
  "visibility": "company",
  "team_id": null,
  "favorite": false,
  "can_edit": true,
  "updated_at": "2026-09-03T10:00:00Z"
}

Operation path

The same operation is also at POST /v1/ops/messaging_update_quick_message, with every field in the JSON body.