Zaiped
Para vocêPara desenvolvedores
EntrarCriar conta
Para vocêPara desenvolvedores
Referência REST

Flows

As rotas de Flows. Todo corpo é JSON, e o erro sempre volta como um objeto com código e mensagem.

GET

/v1/flows

List WhatsApp Flows

Resposta (object[])

idstringObrigatório
Zaiped id (flows)
namestringObrigatório
categoriesstring[]Obrigatório
status"local" | "draft" | "published" | "deprecated" | "blocked" | "throttled"Obrigatório
metaFlowIdstring
flowJsonstringObrigatório
validationErrorsobject[]
previewUrlstring
responseCountnumberObrigatório
updatedAtnumberObrigatório
curl -X GET "https://zaiped.com/v1/flows" \
  -H "Authorization: Bearer zp_..."
POST

/v1/flows

Create a Flow

Corpo da requisição

namestringObrigatório
categoriesstring[]Obrigatório
flowJsonstring
librarystring
lang"pt-BR" | "en-US"
pushboolean

Resposta (object)

idstringObrigatório
Zaiped id (flows)
namestringObrigatório
categoriesstring[]Obrigatório
status"local" | "draft" | "published" | "deprecated" | "blocked" | "throttled"Obrigatório
metaFlowIdstring
flowJsonstringObrigatório
validationErrorsobject[]
previewUrlstring
responseCountnumberObrigatório
updatedAtnumberObrigatório
curl -X POST "https://zaiped.com/v1/flows" \
  -H "Authorization: Bearer zp_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "…",
  "categories": []
}'
GET

/v1/flows/{flowId}

Get a Flow

Parâmetros de caminho

flowIdstringObrigatório
The flow id, as returned by list_flows.

Resposta (object)

idstringObrigatório
Zaiped id (flows)
namestringObrigatório
categoriesstring[]Obrigatório
status"local" | "draft" | "published" | "deprecated" | "blocked" | "throttled"Obrigatório
metaFlowIdstring
flowJsonstringObrigatório
validationErrorsobject[]
previewUrlstring
responseCountnumberObrigatório
updatedAtnumberObrigatório
curl -X GET "https://zaiped.com/v1/flows/YOUR_FLOW_ID" \
  -H "Authorization: Bearer zp_..."
PUT

/v1/flows/{flowId}

Update a Flow

The JSON of a published flow is immutable at Meta; name and categories still change.

Parâmetros de caminho

flowIdstringObrigatório
The flow id.

Corpo da requisição

namestring
categoriesstring[]
flowJsonstring
pushboolean

Resposta (object)

idstringObrigatório
Zaiped id (flows)
namestringObrigatório
categoriesstring[]Obrigatório
status"local" | "draft" | "published" | "deprecated" | "blocked" | "throttled"Obrigatório
metaFlowIdstring
flowJsonstringObrigatório
validationErrorsobject[]
previewUrlstring
responseCountnumberObrigatório
updatedAtnumberObrigatório
curl -X PUT "https://zaiped.com/v1/flows/YOUR_FLOW_ID" \
  -H "Authorization: Bearer zp_..." \
  -H "Content-Type: application/json" \
  -d '{}'
DELETE

/v1/flows/{flowId}

Delete a Flow

Parâmetros de caminho

flowIdstringObrigatório
The flow id.

Resposta (object)

oktrueObrigatório
curl -X DELETE "https://zaiped.com/v1/flows/YOUR_FLOW_ID" \
  -H "Authorization: Bearer zp_..."
POST

/v1/flows/{flowId}/publish

Publish a Flow

Pushes the current JSON, requires zero validation errors and publishes.

Parâmetros de caminho

flowIdstringObrigatório
The flow id.

Resposta (object)

oktrueObrigatório
curl -X POST "https://zaiped.com/v1/flows/YOUR_FLOW_ID/publish" \
  -H "Authorization: Bearer zp_..."
POST

/v1/flows/{flowId}/deprecate

Deprecate a published Flow

Parâmetros de caminho

flowIdstringObrigatório
The flow id.

Resposta (object)

oktrueObrigatório
curl -X POST "https://zaiped.com/v1/flows/YOUR_FLOW_ID/deprecate" \
  -H "Authorization: Bearer zp_..."
GET

/v1/flows/{flowId}/responses

List responses to a Flow

Parâmetros de caminho

flowIdstringObrigatório
The flow id.

Resposta (object)

rowsobject[]Obrigatório
truncatedbooleanObrigatório
curl -X GET "https://zaiped.com/v1/flows/YOUR_FLOW_ID/responses" \
  -H "Authorization: Bearer zp_..."
Referência REST