Actualizar campaña
curl --request PATCH \
--url https://api.notifique.dev/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"templateId": "<string>",
"channels": [],
"segmentId": "<string>",
"audienceContactIds": [
"<string>"
],
"scheduledFor": "2023-11-07T05:31:56Z",
"instanceId": "<string>",
"telegramInstanceId": "<string>",
"fromEmail": "<string>",
"variables": {}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
templateId: '<string>',
channels: [],
segmentId: '<string>',
audienceContactIds: ['<string>'],
scheduledFor: '2023-11-07T05:31:56Z',
instanceId: '<string>',
telegramInstanceId: '<string>',
fromEmail: '<string>',
variables: {}
})
};
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": "<string>",
"templateId": "<string>",
"channels": [],
"segmentId": "<string>",
"audienceContactIds": ["<string>"],
"scheduledFor": "2023-11-07T05:31:56Z",
"instanceId": "<string>",
"telegramInstanceId": "<string>",
"fromEmail": "<string>",
"variables": {}
}
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\": \"<string>\",\n \"templateId\": \"<string>\",\n \"channels\": [],\n \"segmentId\": \"<string>\",\n \"audienceContactIds\": [\n \"<string>\"\n ],\n \"scheduledFor\": \"2023-11-07T05:31:56Z\",\n \"instanceId\": \"<string>\",\n \"telegramInstanceId\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"variables\": {}\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": "<string>",
"name": "<string>",
"templateId": "<string>",
"channels": [],
"segmentId": "<string>",
"audienceContactIds": [
"<string>"
],
"scheduledFor": "2023-11-07T05:31:56Z",
"instanceId": "<string>",
"telegramInstanceId": "<string>",
"fromEmail": "<string>",
"variables": {},
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"audienceCount": 123,
"lastRunAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}Campanhas
Actualizar campaña
Actualiza un campaña.
PATCH
/
v1
/
campaigns
/
{campaignId}
Actualizar campaña
curl --request PATCH \
--url https://api.notifique.dev/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"templateId": "<string>",
"channels": [],
"segmentId": "<string>",
"audienceContactIds": [
"<string>"
],
"scheduledFor": "2023-11-07T05:31:56Z",
"instanceId": "<string>",
"telegramInstanceId": "<string>",
"fromEmail": "<string>",
"variables": {}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
templateId: '<string>',
channels: [],
segmentId: '<string>',
audienceContactIds: ['<string>'],
scheduledFor: '2023-11-07T05:31:56Z',
instanceId: '<string>',
telegramInstanceId: '<string>',
fromEmail: '<string>',
variables: {}
})
};
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": "<string>",
"templateId": "<string>",
"channels": [],
"segmentId": "<string>",
"audienceContactIds": ["<string>"],
"scheduledFor": "2023-11-07T05:31:56Z",
"instanceId": "<string>",
"telegramInstanceId": "<string>",
"fromEmail": "<string>",
"variables": {}
}
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\": \"<string>\",\n \"templateId\": \"<string>\",\n \"channels\": [],\n \"segmentId\": \"<string>\",\n \"audienceContactIds\": [\n \"<string>\"\n ],\n \"scheduledFor\": \"2023-11-07T05:31:56Z\",\n \"instanceId\": \"<string>\",\n \"telegramInstanceId\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"variables\": {}\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": "<string>",
"name": "<string>",
"templateId": "<string>",
"channels": [],
"segmentId": "<string>",
"audienceContactIds": [
"<string>"
],
"scheduledFor": "2023-11-07T05:31:56Z",
"instanceId": "<string>",
"telegramInstanceId": "<string>",
"fromEmail": "<string>",
"variables": {},
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"audienceCount": 123,
"lastRunAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>",
"code": "<string>"
}Autorizaciones
ntfContactBearerAuthntfContactApiKeyHeader
Autorización: Portador sk_live_xxxxx
Parámetros de ruta
Cuerpo
application/json
Maximum string length:
128Cambie la plantilla de la campaña (no utilice null para eliminarla; la campaña siempre requiere una plantilla).
Minimum string length:
1Canal de campaña (crear/actualizar): whatsapp, sms, email, telegram. Debe ser un subconjunto de canales habilitados en la plantilla. Las plantillas pueden habilitar RCS/Push/voz; La campaña creada a través de API/panel utiliza estos cuatro.
Opciones disponibles:
whatsapp, sms, email, telegram Instancia de WhatsApp
Instancia de telegrama
Show child attributes
Show child attributes
¿Esta página le ayudó?
⌘I

