# 📣 Campanhas

## POST /v2/api/external/{ApiID}/campaign/cancel/{campaignId}

> CampaignCancel

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/cancel/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignCancel","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/contacts/add/{campaignId}

> CampaignContactsAdd

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/contacts/add/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignContactsAdd","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"string"}}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## GET /v2/api/external/{ApiID}/campaign/contacts/{campaignId}

> CampaignContactsList

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/contacts/{campaignId}":{"get":{"tags":["📣 Campanhas"],"summary":"CampaignContactsList","parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId}

> CampaignContactsRemove

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignContactsRemove","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true},{"name":"contactId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId}

> CampaignContactsRemoveAll

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignContactsRemoveAll","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/create

> CampaignCreate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/create":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start":{"type":"string"},"message1":{"type":"string"},"message2":{"type":"string"},"message3":{"type":"string"},"sessionId":{"type":"string"},"delay":{"type":"string"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/delete/{campaignId}

> CampaignDelete

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/delete/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignDelete","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/duplicate/{campaignId}

> CampaignDuplicate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/duplicate/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignDuplicate","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## GET /v2/api/external/{ApiID}/campaign/list

> CampaignList

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/list":{"get":{"tags":["📣 Campanhas"],"summary":"CampaignList","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"limit","in":"query","schema":{"type":"integer"}},{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/pause/{campaignId}

> CampaignPause

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/pause/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignPause","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## GET /v2/api/external/{ApiID}/campaign/report/{campaignId}

> CampaignReport

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/report/{campaignId}":{"get":{"tags":["📣 Campanhas"],"summary":"CampaignReport","parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/resume/{campaignId}

> CampaignResume

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/resume/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignResume","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/skip/{campaignId}

> CampaignSkip

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/skip/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignSkip","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/start/{campaignId}

> CampaignStart

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/start/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignStart","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/campaign/update/{campaignId}

> CampaignUpdate

```json
{"openapi":"3.0.0","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"📣 Campanhas"}],"servers":[{"url":"https://{{baseurl}}"},{"url":"https://{{BaseUrl}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/campaign/update/{campaignId}":{"post":{"tags":["📣 Campanhas"],"summary":"CampaignUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start":{"type":"string"},"message1":{"type":"string"},"message2":{"type":"string"},"message3":{"type":"string"},"sessionId":{"type":"string"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"campaignId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ajuda.zdg.com.br/central-do-assinante/referencia-da-api/campanhas.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.