Atualiza uma ação agendada
curl --request PUT \
--url https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id} \
--header 'Content-Type: application/json' \
--header 'X-Ambiente: <api-key>' \
--header 'X-Authorization: <api-key>' \
--data '
{
"TipoAcao": "<string>",
"DataAgendada": "2023-11-07T05:31:56Z",
"Payload": "<string>",
"IdNegocio": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdContato": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdConversa": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdTemplate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdSessaoJornada": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"MaximoTentativas": 50,
"TipoRecorrencia": "<string>",
"ConfiguracaoRecorrencia": "<string>",
"PoliticaDeInstancia": "<string>"
}
'import requests
url = "https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}"
payload = {
"TipoAcao": "<string>",
"DataAgendada": "2023-11-07T05:31:56Z",
"Payload": "<string>",
"IdNegocio": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdContato": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdConversa": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdTemplate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdSessaoJornada": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"MaximoTentativas": 50,
"TipoRecorrencia": "<string>",
"ConfiguracaoRecorrencia": "<string>",
"PoliticaDeInstancia": "<string>"
}
headers = {
"X-Ambiente": "<api-key>",
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Ambiente': '<api-key>',
'X-Authorization': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
TipoAcao: '<string>',
DataAgendada: '2023-11-07T05:31:56Z',
Payload: '<string>',
IdNegocio: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdContato: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdConversa: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdTemplate: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdSessaoJornada: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
MaximoTentativas: 50,
TipoRecorrencia: '<string>',
ConfiguracaoRecorrencia: '<string>',
PoliticaDeInstancia: '<string>'
})
};
fetch('https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'TipoAcao' => '<string>',
'DataAgendada' => '2023-11-07T05:31:56Z',
'Payload' => '<string>',
'IdNegocio' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdContato' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdConversa' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdTemplate' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdSessaoJornada' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'MaximoTentativas' => 50,
'TipoRecorrencia' => '<string>',
'ConfiguracaoRecorrencia' => '<string>',
'PoliticaDeInstancia' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ambiente: <api-key>",
"X-Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}"
payload := strings.NewReader("{\n \"TipoAcao\": \"<string>\",\n \"DataAgendada\": \"2023-11-07T05:31:56Z\",\n \"Payload\": \"<string>\",\n \"IdNegocio\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdContato\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdConversa\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdTemplate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdSessaoJornada\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"MaximoTentativas\": 50,\n \"TipoRecorrencia\": \"<string>\",\n \"ConfiguracaoRecorrencia\": \"<string>\",\n \"PoliticaDeInstancia\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Ambiente", "<api-key>")
req.Header.Add("X-Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}")
.header("X-Ambiente", "<api-key>")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"TipoAcao\": \"<string>\",\n \"DataAgendada\": \"2023-11-07T05:31:56Z\",\n \"Payload\": \"<string>\",\n \"IdNegocio\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdContato\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdConversa\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdTemplate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdSessaoJornada\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"MaximoTentativas\": 50,\n \"TipoRecorrencia\": \"<string>\",\n \"ConfiguracaoRecorrencia\": \"<string>\",\n \"PoliticaDeInstancia\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Ambiente"] = '<api-key>'
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"TipoAcao\": \"<string>\",\n \"DataAgendada\": \"2023-11-07T05:31:56Z\",\n \"Payload\": \"<string>\",\n \"IdNegocio\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdContato\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdConversa\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdTemplate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdSessaoJornada\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"MaximoTentativas\": 50,\n \"TipoRecorrencia\": \"<string>\",\n \"ConfiguracaoRecorrencia\": \"<string>\",\n \"PoliticaDeInstancia\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TipoAcao": "<string>",
"DataAgendada": "2023-11-07T05:31:56Z",
"Payload": "<string>",
"IdNegocio": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdContato": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdConversa": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdTemplate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"MaximoTentativas": 123,
"IdSessaoJornada": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TipoRecorrencia": "<string>",
"ConfiguracaoRecorrencia": "<string>",
"PoliticaDeInstancia": "<string>",
"Status": "<string>",
"TentativasRealizadas": 123,
"UltimoErro": "<string>",
"DataDaCriacao": "2023-11-07T05:31:56Z",
"DataDaExecucao": "2023-11-07T05:31:56Z",
"DataDoCancelamento": "2023-11-07T05:31:56Z",
"MotivoCancelamento": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}Ações agendadas
Substituir ação agendada
Apenas ações no status ‘Agendada’ podem ser alteradas (409 caso contrário).
PUT
/
v1
/
acoes-agendadas
/
{id}
Atualiza uma ação agendada
curl --request PUT \
--url https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id} \
--header 'Content-Type: application/json' \
--header 'X-Ambiente: <api-key>' \
--header 'X-Authorization: <api-key>' \
--data '
{
"TipoAcao": "<string>",
"DataAgendada": "2023-11-07T05:31:56Z",
"Payload": "<string>",
"IdNegocio": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdContato": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdConversa": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdTemplate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdSessaoJornada": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"MaximoTentativas": 50,
"TipoRecorrencia": "<string>",
"ConfiguracaoRecorrencia": "<string>",
"PoliticaDeInstancia": "<string>"
}
'import requests
url = "https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}"
payload = {
"TipoAcao": "<string>",
"DataAgendada": "2023-11-07T05:31:56Z",
"Payload": "<string>",
"IdNegocio": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdContato": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdConversa": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdTemplate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdSessaoJornada": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"MaximoTentativas": 50,
"TipoRecorrencia": "<string>",
"ConfiguracaoRecorrencia": "<string>",
"PoliticaDeInstancia": "<string>"
}
headers = {
"X-Ambiente": "<api-key>",
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Ambiente': '<api-key>',
'X-Authorization': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
TipoAcao: '<string>',
DataAgendada: '2023-11-07T05:31:56Z',
Payload: '<string>',
IdNegocio: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdContato: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdConversa: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdTemplate: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
IdSessaoJornada: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
MaximoTentativas: 50,
TipoRecorrencia: '<string>',
ConfiguracaoRecorrencia: '<string>',
PoliticaDeInstancia: '<string>'
})
};
fetch('https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'TipoAcao' => '<string>',
'DataAgendada' => '2023-11-07T05:31:56Z',
'Payload' => '<string>',
'IdNegocio' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdContato' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdConversa' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdTemplate' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'IdSessaoJornada' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'MaximoTentativas' => 50,
'TipoRecorrencia' => '<string>',
'ConfiguracaoRecorrencia' => '<string>',
'PoliticaDeInstancia' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ambiente: <api-key>",
"X-Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}"
payload := strings.NewReader("{\n \"TipoAcao\": \"<string>\",\n \"DataAgendada\": \"2023-11-07T05:31:56Z\",\n \"Payload\": \"<string>\",\n \"IdNegocio\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdContato\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdConversa\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdTemplate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdSessaoJornada\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"MaximoTentativas\": 50,\n \"TipoRecorrencia\": \"<string>\",\n \"ConfiguracaoRecorrencia\": \"<string>\",\n \"PoliticaDeInstancia\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Ambiente", "<api-key>")
req.Header.Add("X-Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}")
.header("X-Ambiente", "<api-key>")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"TipoAcao\": \"<string>\",\n \"DataAgendada\": \"2023-11-07T05:31:56Z\",\n \"Payload\": \"<string>\",\n \"IdNegocio\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdContato\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdConversa\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdTemplate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdSessaoJornada\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"MaximoTentativas\": 50,\n \"TipoRecorrencia\": \"<string>\",\n \"ConfiguracaoRecorrencia\": \"<string>\",\n \"PoliticaDeInstancia\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-publica.cpluschat.com.br/v1/acoes-agendadas/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Ambiente"] = '<api-key>'
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"TipoAcao\": \"<string>\",\n \"DataAgendada\": \"2023-11-07T05:31:56Z\",\n \"Payload\": \"<string>\",\n \"IdNegocio\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdContato\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdConversa\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdTemplate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"IdSessaoJornada\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"MaximoTentativas\": 50,\n \"TipoRecorrencia\": \"<string>\",\n \"ConfiguracaoRecorrencia\": \"<string>\",\n \"PoliticaDeInstancia\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TipoAcao": "<string>",
"DataAgendada": "2023-11-07T05:31:56Z",
"Payload": "<string>",
"IdNegocio": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdContato": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdConversa": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"IdTemplate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"MaximoTentativas": 123,
"IdSessaoJornada": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TipoRecorrencia": "<string>",
"ConfiguracaoRecorrencia": "<string>",
"PoliticaDeInstancia": "<string>",
"Status": "<string>",
"TentativasRealizadas": 123,
"UltimoErro": "<string>",
"DataDaCriacao": "2023-11-07T05:31:56Z",
"DataDaExecucao": "2023-11-07T05:31:56Z",
"DataDoCancelamento": "2023-11-07T05:31:56Z",
"MotivoCancelamento": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}Authorizations
Número da sua conta no Novus CRM. Aceita também X-Canal com o ID de um canal, que resolve a conta a partir dele.
Chave de API no formato X-Chave-Api {chave}. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.
Path Parameters
Body
application/json
Minimum string length:
1Required range:
1 <= x <= 100Response
OK
⌘I