Esta pagina resume os endpoints da tag Campaigns, com foco em leitura rapida por integradores e equipes de produto.
/tenants/{tenant_id}/campaigns/{campaign_id}/pausePausar campanha
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| campaign_id | path | Sim |
Respostas
200
Campanha pausada
401
Sem descricao adicional.
404
Sem descricao adicional.
409
Sem descricao adicional.
/tenants/{tenant_id}/campaigns/{campaign_id}/resumeRetomar campanha
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| campaign_id | path | Sim |
Respostas
200
Campanha retomada
401
Sem descricao adicional.
404
Sem descricao adicional.
409
Sem descricao adicional.
/tenants/{tenant_id}/campaigns/{campaign_id}Excluir campanha
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| campaign_id | path | Sim |
Respostas
204
Excluído
401
Sem descricao adicional.
404
Sem descricao adicional.
/tenants/{tenant_id}/campaigns/{campaign_id}Obter campanha por ID
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| campaign_id | path | Sim |
Respostas
200
Campanha
401
Sem descricao adicional.
404
Sem descricao adicional.
/tenants/{tenant_id}/campaigns/{campaign_id}Atualizar campanha (parcial)
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| campaign_id | path | Sim |
Respostas
200
Campanha atualizada
400
Sem descricao adicional.
401
Sem descricao adicional.
404
Sem descricao adicional.
/tenants/{tenant_id}/campaigns/{campaign_id}Atualizar campanha (completo)
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| campaign_id | path | Sim |
Respostas
200
Campanha atualizada
400
Sem descricao adicional.
401
Sem descricao adicional.
404
Sem descricao adicional.
/tenants/{tenant_id}/campaignsListar campanhas
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
| page | query | Nao |
| page_size | query | Nao |
| sort | query | Nao |
Respostas
200
Lista de campanhas
401
Sem descricao adicional.
/tenants/{tenant_id}/campaignsCriar campanha
Parametros
| Nome | Origem | Obrigatorio |
|---|---|---|
| tenant_id | path | Sim |
Respostas
201
Campanha criada
400
Sem descricao adicional.
401
Sem descricao adicional.
409
Sem descricao adicional.