Patch Template
const url = 'https://example.com/platform/v1/templates/1';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"body_text":"example","category":"example","components":[{"example":{"header_handle":["example"],"header_text":["example"]},"format":"TEXT","text":"example","type":"HEADER"}],"parameter_format":"NAMED","variables":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/platform/v1/templates/1 \ --header 'Content-Type: application/json' \ --data '{ "body_text": "example", "category": "example", "components": [ { "example": { "header_handle": [ "example" ], "header_text": [ "example" ] }, "format": "TEXT", "text": "example", "type": "HEADER" } ], "parameter_format": "NAMED", "variables": [ "example" ] }'Edit an APPROVED/REJECTED template’s components and re-submit to Meta.
Status mapping:
* not found / not owned → 404 (opaque).
* PENDING template → 409 status_locked (Meta refuses to edit
pending templates).
* legacy row with no stored components AND no patch components →
422 legacy_row_supply_components (the dev must re-submit).
* channel missing or missing credentials → 422.
* invalid component shape → 422.
* Meta rejection → returned row with meta_status='rejected'
(managed parity — no raise).
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Request Body required
Section titled “Request Body required ”Partial update — any subset of editable fields.
Per Meta’s edit endpoint (POST /{message_template_id}, DP-A verified),
the editable surface is components + category + parameter_format.
PENDING templates cannot be edited (the service raises status_locked →
409). The router accepts a partial body — exclude_none is applied in
the handler.
object
HEADER — one per template/card. format drives the invariants.
TEXT requires text; IMAGE/VIDEO/DOCUMENT require
example.header_handle; LOCATION carries neither. Enforced by
build_template_components._build_header.
object
HEADER example — header_text (TEXT) XOR header_handle (media).
header_handle is the list-of-one Meta upload handle returned by
POST /platform/v1/templates/header-media.
object
BODY — exactly one per template/card scope.
text is required for utility/marketing and FORBIDDEN for
authentication (Meta renders the OTP copy), so the requirement is enforced
category-aware in the builder, not here.
add_security_recommendation is the authentication-only flag.
object
BODY example — POSITIONAL body_text XOR NAMED
body_text_named_params.
POSITIONAL is Meta’s list-of-one-list: {"body_text": [["Ada", "A-123"]]}.
object
One parameter_format=NAMED body placeholder (companion §2.2).
object
FOOTER — at most one.
Regular templates carry text; authentication templates carry
code_expiration_minutes (1..90) instead, per Meta.
BUTTONS — non-empty; per-type count rules stay in the builder.
object
QUICK_REPLY — a label the recipient taps to send back a payload.
object
URL — static or Meta-supported dynamic ({{1}}) link.
example is Meta’s list of fully-resolved example URLs (dynamic only).
object
PHONE_NUMBER — tap-to-call.
object
COPY_CODE — coupon copy button. example is the code STRING.
Never treated as a URL button. text is optional because the built
array Meta receives carries only type + example.
OTP — authentication-category button (COPY_CODE/ONE_TAP/ZERO_TAP).
supported_apps is the field the builder actually consumes for
ONE_TAP/ZERO_TAP. package_name / signature_hash / autofill_text
are accepted as the companion documents them (Meta’s flat single-app form)
and are passed through untouched; the builder ignores them.
object
One ONE_TAP/ZERO_TAP target app (passthrough — Meta owns the values).
object
CATALOG — opens the business catalog (passthrough).
CAROUSEL — top-level only, 2..10 cards, never nested.
object
One carousel card — its own typed component sub-tree, order preserved.
object
HEADER — one per template/card. format drives the invariants.
TEXT requires text; IMAGE/VIDEO/DOCUMENT require
example.header_handle; LOCATION carries neither. Enforced by
build_template_components._build_header.
object
HEADER example — header_text (TEXT) XOR header_handle (media).
header_handle is the list-of-one Meta upload handle returned by
POST /platform/v1/templates/header-media.
object
BODY — exactly one per template/card scope.
text is required for utility/marketing and FORBIDDEN for
authentication (Meta renders the OTP copy), so the requirement is enforced
category-aware in the builder, not here.
add_security_recommendation is the authentication-only flag.
object
BODY example — POSITIONAL body_text XOR NAMED
body_text_named_params.
POSITIONAL is Meta’s list-of-one-list: {"body_text": [["Ada", "A-123"]]}.
object
One parameter_format=NAMED body placeholder (companion §2.2).
object
BUTTONS — non-empty; per-type count rules stay in the builder.
object
QUICK_REPLY — a label the recipient taps to send back a payload.
object
URL — static or Meta-supported dynamic ({{1}}) link.
example is Meta’s list of fully-resolved example URLs (dynamic only).
object
PHONE_NUMBER — tap-to-call.
object
COPY_CODE — coupon copy button. example is the code STRING.
Never treated as a URL button. text is optional because the built
array Meta receives carries only type + example.
OTP — authentication-category button (COPY_CODE/ONE_TAP/ZERO_TAP).
supported_apps is the field the builder actually consumes for
ONE_TAP/ZERO_TAP. package_name / signature_hash / autofill_text
are accepted as the companion documents them (Meta’s flat single-app form)
and are passed through untouched; the builder ignores them.
object
One ONE_TAP/ZERO_TAP target app (passthrough — Meta owns the values).
object
CATALOG — opens the business catalog (passthrough).
Responses
Section titled “ Responses ”Successful Response
Response shape — exposes Meta status snapshot + WF6 component fields.
object
HEADER — one per template/card. format drives the invariants.
TEXT requires text; IMAGE/VIDEO/DOCUMENT require
example.header_handle; LOCATION carries neither. Enforced by
build_template_components._build_header.
object
HEADER example — header_text (TEXT) XOR header_handle (media).
header_handle is the list-of-one Meta upload handle returned by
POST /platform/v1/templates/header-media.
object
BODY — exactly one per template/card scope.
text is required for utility/marketing and FORBIDDEN for
authentication (Meta renders the OTP copy), so the requirement is enforced
category-aware in the builder, not here.
add_security_recommendation is the authentication-only flag.
object
BODY example — POSITIONAL body_text XOR NAMED
body_text_named_params.
POSITIONAL is Meta’s list-of-one-list: {"body_text": [["Ada", "A-123"]]}.
object
One parameter_format=NAMED body placeholder (companion §2.2).
object
FOOTER — at most one.
Regular templates carry text; authentication templates carry
code_expiration_minutes (1..90) instead, per Meta.
BUTTONS — non-empty; per-type count rules stay in the builder.
object
QUICK_REPLY — a label the recipient taps to send back a payload.
object
URL — static or Meta-supported dynamic ({{1}}) link.
example is Meta’s list of fully-resolved example URLs (dynamic only).
object
PHONE_NUMBER — tap-to-call.
object
COPY_CODE — coupon copy button. example is the code STRING.
Never treated as a URL button. text is optional because the built
array Meta receives carries only type + example.
OTP — authentication-category button (COPY_CODE/ONE_TAP/ZERO_TAP).
supported_apps is the field the builder actually consumes for
ONE_TAP/ZERO_TAP. package_name / signature_hash / autofill_text
are accepted as the companion documents them (Meta’s flat single-app form)
and are passed through untouched; the builder ignores them.
object
One ONE_TAP/ZERO_TAP target app (passthrough — Meta owns the values).
object
CATALOG — opens the business catalog (passthrough).
Read-path CAROUSEL — cards use the tolerant card union.
object
Read-path carousel card — tolerates unmodelled card components.
object
HEADER — one per template/card. format drives the invariants.
TEXT requires text; IMAGE/VIDEO/DOCUMENT require
example.header_handle; LOCATION carries neither. Enforced by
build_template_components._build_header.
object
HEADER example — header_text (TEXT) XOR header_handle (media).
header_handle is the list-of-one Meta upload handle returned by
POST /platform/v1/templates/header-media.
object
BODY — exactly one per template/card scope.
text is required for utility/marketing and FORBIDDEN for
authentication (Meta renders the OTP copy), so the requirement is enforced
category-aware in the builder, not here.
add_security_recommendation is the authentication-only flag.
object
BODY example — POSITIONAL body_text XOR NAMED
body_text_named_params.
POSITIONAL is Meta’s list-of-one-list: {"body_text": [["Ada", "A-123"]]}.
object
One parameter_format=NAMED body placeholder (companion §2.2).
object
BUTTONS — non-empty; per-type count rules stay in the builder.
object
QUICK_REPLY — a label the recipient taps to send back a payload.
object
URL — static or Meta-supported dynamic ({{1}}) link.
example is Meta’s list of fully-resolved example URLs (dynamic only).
object
PHONE_NUMBER — tap-to-call.
object
COPY_CODE — coupon copy button. example is the code STRING.
Never treated as a URL button. text is optional because the built
array Meta receives carries only type + example.
OTP — authentication-category button (COPY_CODE/ONE_TAP/ZERO_TAP).
supported_apps is the field the builder actually consumes for
ONE_TAP/ZERO_TAP. package_name / signature_hash / autofill_text
are accepted as the companion documents them (Meta’s flat single-app form)
and are passed through untouched; the builder ignores them.
object
One ONE_TAP/ZERO_TAP target app (passthrough — Meta owns the values).
object
CATALOG — opens the business catalog (passthrough).
object
object
Example
{ "components": [ { "format": "TEXT", "type": "HEADER" } ]}Validation Error
object
object
object
Example generated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}