Marketing Campaigns
Campanhas e disparos
GET/api/marketing-campaigns
Escopo exigido: campaigns.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
search | query | não |
status | query | não |
channelId | query | não |
page | query | não |
limit | query | não |
bash
curl "https://api.zapyflow.com.br/api/marketing-campaigns" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/marketing-campaigns
Escopo exigido: campaigns.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 1, max 160 |
channelId | string | sim | min 1 |
channelTemplateId | string | sim | min 1 |
timezone | string | não | min 1, max 80 |
audienceSource | "CONTACTS" | "CSV" | sim | — |
stopOnReply | boolean | não | — |
sendIntervalMs | integer | não | ≥ 250, ≤ 60000 |
bash
curl -X POST "https://api.zapyflow.com.br/api/marketing-campaigns" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado
GET/api/marketing-campaigns/{id}
Escopo exigido: campaigns.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/marketing-campaigns/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
PUT/api/marketing-campaigns/{id}
Escopo exigido: campaigns.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 1, max 160 |
channelId | string | sim | min 1 |
channelTemplateId | string | sim | min 1 |
timezone | string | não | min 1, max 80 |
audienceSource | "CONTACTS" | "CSV" | sim | — |
stopOnReply | boolean | não | — |
sendIntervalMs | integer | não | ≥ 250, ≤ 60000 |
bash
curl -X PUT "https://api.zapyflow.com.br/api/marketing-campaigns/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK
PUT/api/marketing-campaigns/{id}/audience
Escopo exigido: campaigns.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
rows | object[] | sim | ≤ 10000 items |
bash
curl -X PUT "https://api.zapyflow.com.br/api/marketing-campaigns/{id}/audience" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK
POST/api/marketing-campaigns/{id}/duplicate
Escopo exigido: campaigns.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/marketing-campaigns/{id}/duplicate" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
201— Criado
GET/api/marketing-campaigns/{id}/recipients
Escopo exigido: campaigns.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
search | query | não |
status | query | não |
page | query | não |
limit | query | não |
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/marketing-campaigns/{id}/recipients" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/marketing-campaigns/{id}/report
Escopo exigido: campaigns.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/marketing-campaigns/{id}/report" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
PUT/api/marketing-campaigns/{id}/variables
Escopo exigido: campaigns.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
mappings | object[] | sim | ≤ 50 items |
bash
curl -X PUT "https://api.zapyflow.com.br/api/marketing-campaigns/{id}/variables" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK
POST/api/marketing-campaigns/audience/contacts
Escopo exigido: campaigns.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
search | string | não | max 120 |
channelId | string | não | min 1 |
tags | string[] | não | ≤ 20 items |
bash
curl -X POST "https://api.zapyflow.com.br/api/marketing-campaigns/audience/contacts" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK
POST/api/marketing-campaigns/audience/csv/validate
Escopo exigido: campaigns.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
csv | string | sim | min 1, max 5242880 |
bash
curl -X POST "https://api.zapyflow.com.br/api/marketing-campaigns/audience/csv/validate" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK