Skip to main content
PATCH
Update form

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Path Parameters

id
string
required

ID da lista (ex.: cuid)

Body

application/json

Atualização parcial. Pelo menos um campo é obrigatório. Campos aninhados (hostedPageTheme, hostedPageCopy, hostedPageForm) fazem merge com o valor atual; null reseta o bloco.

name
string
Required string length: 1 - 128
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CLOSED,
ENDED
doubleOptInEnabled
boolean

Ignorado para template NEWSLETTER (sempre false).

endedMessage
string | null
features
object
hostedPageTheme
object | null

Merge parcial do tema da página hospedada.

hostedPageCopy
object | null

Merge parcial dos textos da página hospedada.

hostedPageForm
object | null

Merge parcial do schema do formulário. Validado com validateFormConfig antes de salvar.

Response

Atualizado

success
boolean
Example:

true

data
object