Atualizar campanha
curl --request PATCH \
--url https://api.notifique.dev/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Exemplo",
"templateId": "clxx...",
"channels": [
"whatsapp"
],
"segmentId": "clxx...",
"audienceContactIds": [
"clxx..."
],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"sendingPoolId": "clxx..."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Exemplo',
templateId: 'clxx...',
channels: ['whatsapp'],
segmentId: 'clxx...',
audienceContactIds: ['clxx...'],
scheduledFor: '2025-02-10T14:00:00.000Z',
instanceId: 'clxx...',
telegramInstanceId: 'clxx...',
fromEmail: 'string',
channelFailureMode: 'STRICT',
variables: {},
sendingPoolId: 'clxx...'
})
};
fetch('https://api.notifique.dev/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/campaigns/{campaignId}"
payload = {
"name": "Exemplo",
"templateId": "clxx...",
"channels": ["whatsapp"],
"segmentId": "clxx...",
"audienceContactIds": ["clxx..."],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"sendingPoolId": "clxx..."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/campaigns/{campaignId}"
payload := strings.NewReader("{\n \"name\": \"Exemplo\",\n \"templateId\": \"clxx...\",\n \"channels\": [\n \"whatsapp\"\n ],\n \"segmentId\": \"clxx...\",\n \"audienceContactIds\": [\n \"clxx...\"\n ],\n \"scheduledFor\": \"2025-02-10T14:00:00.000Z\",\n \"instanceId\": \"clxx...\",\n \"telegramInstanceId\": \"clxx...\",\n \"fromEmail\": \"string\",\n \"channelFailureMode\": \"STRICT\",\n \"variables\": {},\n \"sendingPoolId\": \"clxx...\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"success": true,
"data": {
"id": "clxx...",
"name": "Exemplo",
"status": "DRAFT",
"templateId": "clxx...",
"channels": [
"whatsapp"
],
"segmentId": "clxx...",
"audienceContactIds": [
"clxx..."
],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"lastRunAt": "2025-02-10T14:00:00.000Z",
"sendingPoolId": "clxx..."
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Campanhas
Atualizar campanha
Altera dados de um campanha.
PATCH
/
v1
/
campaigns
/
{campaignId}
Atualizar campanha
curl --request PATCH \
--url https://api.notifique.dev/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Exemplo",
"templateId": "clxx...",
"channels": [
"whatsapp"
],
"segmentId": "clxx...",
"audienceContactIds": [
"clxx..."
],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"sendingPoolId": "clxx..."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Exemplo',
templateId: 'clxx...',
channels: ['whatsapp'],
segmentId: 'clxx...',
audienceContactIds: ['clxx...'],
scheduledFor: '2025-02-10T14:00:00.000Z',
instanceId: 'clxx...',
telegramInstanceId: 'clxx...',
fromEmail: 'string',
channelFailureMode: 'STRICT',
variables: {},
sendingPoolId: 'clxx...'
})
};
fetch('https://api.notifique.dev/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/campaigns/{campaignId}"
payload = {
"name": "Exemplo",
"templateId": "clxx...",
"channels": ["whatsapp"],
"segmentId": "clxx...",
"audienceContactIds": ["clxx..."],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"sendingPoolId": "clxx..."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/campaigns/{campaignId}"
payload := strings.NewReader("{\n \"name\": \"Exemplo\",\n \"templateId\": \"clxx...\",\n \"channels\": [\n \"whatsapp\"\n ],\n \"segmentId\": \"clxx...\",\n \"audienceContactIds\": [\n \"clxx...\"\n ],\n \"scheduledFor\": \"2025-02-10T14:00:00.000Z\",\n \"instanceId\": \"clxx...\",\n \"telegramInstanceId\": \"clxx...\",\n \"fromEmail\": \"string\",\n \"channelFailureMode\": \"STRICT\",\n \"variables\": {},\n \"sendingPoolId\": \"clxx...\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"success": true,
"data": {
"id": "clxx...",
"name": "Exemplo",
"status": "DRAFT",
"templateId": "clxx...",
"channels": [
"whatsapp"
],
"segmentId": "clxx...",
"audienceContactIds": [
"clxx..."
],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"lastRunAt": "2025-02-10T14:00:00.000Z",
"sendingPoolId": "clxx..."
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Autorizações
ntfContactBearerAuthntfContactApiKeyHeader
Authorization: Bearer sk_live_xxxxx
Parâmetros de caminho
Corpo
application/json
Maximum string length:
128Trocar o template da campanha (não use null para remover; a campanha sempre exige template).
Minimum string length:
1Canal na campanha (create/update): whatsapp, sms, email, telegram, push, rcs, instagram. Deve ser subconjunto dos canais habilitados no template.
Opções disponíveis:
whatsapp, sms, email, telegram, push, rcs, instagram Instância WhatsApp
Instância Telegram
Modo de falha por canal.
Opções disponíveis:
STRICT, PARTIAL, strict, partial, pessimistic, optimistic, best_effort Show child attributes
Show child attributes
Sending Pool WhatsApp (alternativa a instanceId quando whatsapp ∈ channels).
Resposta
Atualizada.
Campanha multicanal. channels ⊆ canais habilitados do template (whatsapp|sms|email|telegram). Status: DRAFT, SCHEDULED, RUNNING, COMPLETED, FAILED, CANCELLED.
Show child attributes
Show child attributes
Exemplo:
{
"id": "clxx...",
"name": "Exemplo",
"status": "DRAFT",
"templateId": "clxx...",
"channels": ["whatsapp"],
"segmentId": "clxx...",
"audienceContactIds": ["clxx..."],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"lastRunAt": "2025-02-10T14:00:00.000Z",
"sendingPoolId": "clxx..."
}
Esta página foi útil?

