Skip to main content
POST
Publish Form

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The form's id (form_…).

Response

Published: published is true.

id
string
required

The form's id (form_…).

name
string
required

What you call it. Customers never see it.

agent
string
required

The agent it belongs to (ag_…).

category
enum<string>
required

WhatsApp's category for it. Affects reporting only.

Available options:
SIGN_UP,
APPOINTMENT_BOOKING,
LEAD_GENERATION,
CONTACT_US,
CUSTOMER_SUPPORT,
SURVEY,
OTHER
form
object
required
published
boolean
required

Whether it can be sent. False until published, and again after any edit until it is republished.

publishedAt
string<date-time> | null
required

When it was last published.

createdAt
string<date-time>
required

When it was created.

updatedAt
string<date-time>
required

When it was last changed.