ChatPRO Central de Ajuda

šŸ“£ Campanhas

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

CampaignCancel

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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

{"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":{}}}}}}}}
Isso foi Ćŗtil?
Central de Ajuda ChatPRO · documentação técnica da plataforma