Atualizar campanha

Actualizar campaña

curl --request PUT \
  --url https://api.jelou.ai/v1/campaigns/{campaignId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "promo_fin_de_mes",
  "scheduledAt": "2026-09-27T11:00:00-05:00"
}
'

import requests

url = "https://api.jelou.ai/v1/campaigns/{campaignId}"

payload = {
    "name": "promo_fin_de_mes",
    "scheduledAt": "2026-09-27T11:00:00-05:00"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'promo_fin_de_mes', scheduledAt: '2026-09-27T11:00:00-05:00'})
};

fetch('https://api.jelou.ai/v1/campaigns/{campaignId}', 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.jelou.ai/v1/campaigns/{campaignId}",
  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([
    'name' => 'promo_fin_de_mes',
    'scheduledAt' => '2026-09-27T11:00:00-05:00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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.jelou.ai/v1/campaigns/{campaignId}"

	payload := strings.NewReader("{\n  \"name\": \"promo_fin_de_mes\",\n  \"scheduledAt\": \"2026-09-27T11:00:00-05:00\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.jelou.ai/v1/campaigns/{campaignId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"promo_fin_de_mes\",\n  \"scheduledAt\": \"2026-09-27T11:00:00-05:00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jelou.ai/v1/campaigns/{campaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"promo_fin_de_mes\",\n  \"scheduledAt\": \"2026-09-27T11:00:00-05:00\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": [
    "Campaign has been updated."
  ],
  "statusMessage": "success",
  "status": 1
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

PUT

campaigns

{campaignId}

Actualizar campaña

curl --request PUT \
  --url https://api.jelou.ai/v1/campaigns/{campaignId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "promo_fin_de_mes",
  "scheduledAt": "2026-09-27T11:00:00-05:00"
}
'

import requests

url = "https://api.jelou.ai/v1/campaigns/{campaignId}"

payload = {
    "name": "promo_fin_de_mes",
    "scheduledAt": "2026-09-27T11:00:00-05:00"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'promo_fin_de_mes', scheduledAt: '2026-09-27T11:00:00-05:00'})
};

fetch('https://api.jelou.ai/v1/campaigns/{campaignId}', 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.jelou.ai/v1/campaigns/{campaignId}",
  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([
    'name' => 'promo_fin_de_mes',
    'scheduledAt' => '2026-09-27T11:00:00-05:00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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.jelou.ai/v1/campaigns/{campaignId}"

	payload := strings.NewReader("{\n  \"name\": \"promo_fin_de_mes\",\n  \"scheduledAt\": \"2026-09-27T11:00:00-05:00\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.jelou.ai/v1/campaigns/{campaignId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"promo_fin_de_mes\",\n  \"scheduledAt\": \"2026-09-27T11:00:00-05:00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jelou.ai/v1/campaigns/{campaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"promo_fin_de_mes\",\n  \"scheduledAt\": \"2026-09-27T11:00:00-05:00\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": [
    "Campaign has been updated."
  ],
  "statusMessage": "success",
  "status": 1
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

Endpoint

PUT https://api.jelou.ai/v1/campaigns/{campaignId}

Só é possível atualizar campanhas com status SCHEDULED. Uma campanha que já começou a ser enviada, ou que já terminou, não pode ser atualizada.

Parâmetros de rota

Propriedade	Tipo	Descrição	Obrigatório
campaignId	string	ID da campanha que você quer atualizar. Obtenha-o com o endpoint `GET /v1/campaigns`.	Sim

Corpo da requisição

Propriedade	Tipo	Descrição	Obrigatório
name	string	Novo nome da campanha.	Não
scheduledAt	string	Nova data e hora de envio, no formato ISO 8601 com fuso horário. Deve ser posterior à data e hora atual.	Não

Formato de scheduledAt

scheduledAt usa o formato ISO 8601: YYYY-MM-DDTHH:mm:ss seguido do fuso horário.

Exemplo	Significado
`2026-09-27T16:00:00Z`	27 de setembro de 2026 às 16:00 em UTC.
`2026-09-27T11:00:00-05:00`	27 de setembro de 2026 às 11:00 em UTC-5 (Equador, Colômbia, Peru). É o mesmo instante do exemplo anterior.

Se a data não for válida ou já tiver passado, a API responde com 422 e não altera a campanha.

Exemplo de requisição

curl --request PUT \
  --url https://api.jelou.ai/v1/campaigns/CAMPAIGN_ID \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "promo_fim_de_mes_v2"
  }'

Respostas

200 - Resposta bem-sucedida

{
  "message": ["Campaign has been updated."],
  "statusMessage": "success",
  "status": 1
}

401 - Unauthorized

{
  "message": "Authentication failed"
}

404 - Not Found

{
  "message": ["Campaign not found"],
  "statusMessage": "failed",
  "status": 0
}

422 - Unprocessable Entity

{
  "message": ["Los valores ingresados no son correctos."],
  "statusMessage": "failed",
  "status": 0,
  "validationError": {
    "scheduledAt": [
      {
        "es": "El campo scheduledAt debe ser posterior a la fecha actual",
        "en": "The scheduledAt field must be later than the current date",
        "pt": "O campo scheduledAt deve ser posterior à data atual"
      }
    ]
  }
}

500 - Internal Server Error

{
  "message": ["We are having trouble processing your request. Please try again later."],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta más tarde.",
      "en": "We are having trouble processing your request. Please try again later.",
      "pt": "Estamos tendo problemas com o processo da solicitação. Por favor tente mais tarde."
    }
  }
}

Autorizações

Authorization

string

header

obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

campaignId

string

obrigatório

ID de la campaña (24 caracteres hexadecimales).

Exemplo:

"CAMPAIGN_ID"

Corpo

application/json

name

string

Nuevo nombre de la campaña.

Exemplo:

"promo_fin_de_mes"

scheduledAt

string<date-time>

Nueva fecha y hora de envío en formato ISO 8601 con zona horaria (Z o un desfase como -05:00). Debe ser posterior a la fecha actual.

Exemplo:

"2026-09-27T11:00:00-05:00"

Resposta

Campaign updated

message

string[]

Exemplo:

["Campaign has been updated."]

statusMessage

string

Exemplo:

"success"

status

integer

Exemplo:

1

⌘I

Referência de API

Enviar Mensagens

Campanhas

Conversações

Etiquetas

Métricas

Usuários

Recursos

Widget

Datum

Painel de Atendimento Externo

Canal Personalizado

Gestão de Memória

Endpoint

Parâmetros de rota

Corpo da requisição

Formato de scheduledAt

Exemplo de requisição

Respostas

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Endpoint

​Parâmetros de rota

​Corpo da requisição

​Formato de scheduledAt

​Exemplo de requisição

​Respostas

Autorizações

Parâmetros de caminho

Corpo

Resposta

Endpoint

Parâmetros de rota

Corpo da requisição

Formato de scheduledAt

Exemplo de requisição

Respostas