Update campaign
curl --request PATCH \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaignContactAttributes": [
"<unknown>"
],
"campaignContactIDs": [
"<string>"
],
"campaignContactTags": [
"<string>"
],
"campaignInboxID": "<string>",
"campaignMeta": {},
"campaignModelID": "<string>",
"campaignName": "<string>",
"campaignPluginConnectionID": "<string>",
"campaignSessionTags": [
"<string>"
],
"campaignTag": "<string>",
"dispatchAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}"
payload = {
"campaignContactAttributes": ["<unknown>"],
"campaignContactIDs": ["<string>"],
"campaignContactTags": ["<string>"],
"campaignInboxID": "<string>",
"campaignMeta": {},
"campaignModelID": "<string>",
"campaignName": "<string>",
"campaignPluginConnectionID": "<string>",
"campaignSessionTags": ["<string>"],
"campaignTag": "<string>",
"dispatchAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaignContactAttributes: ['<unknown>'],
campaignContactIDs: ['<string>'],
campaignContactTags: ['<string>'],
campaignInboxID: '<string>',
campaignMeta: {},
campaignModelID: '<string>',
campaignName: '<string>',
campaignPluginConnectionID: '<string>',
campaignSessionTags: ['<string>'],
campaignTag: '<string>',
dispatchAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'campaignContactAttributes' => [
'<unknown>'
],
'campaignContactIDs' => [
'<string>'
],
'campaignContactTags' => [
'<string>'
],
'campaignInboxID' => '<string>',
'campaignMeta' => [
],
'campaignModelID' => '<string>',
'campaignName' => '<string>',
'campaignPluginConnectionID' => '<string>',
'campaignSessionTags' => [
'<string>'
],
'campaignTag' => '<string>',
'dispatchAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}"
payload := strings.NewReader("{\n \"campaignContactAttributes\": [\n \"<unknown>\"\n ],\n \"campaignContactIDs\": [\n \"<string>\"\n ],\n \"campaignContactTags\": [\n \"<string>\"\n ],\n \"campaignInboxID\": \"<string>\",\n \"campaignMeta\": {},\n \"campaignModelID\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"campaignPluginConnectionID\": \"<string>\",\n \"campaignSessionTags\": [\n \"<string>\"\n ],\n \"campaignTag\": \"<string>\",\n \"dispatchAt\": \"2023-11-07T05:31:56Z\"\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))
}HttpResponse<String> response = Unirest.patch("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"campaignContactAttributes\": [\n \"<unknown>\"\n ],\n \"campaignContactIDs\": [\n \"<string>\"\n ],\n \"campaignContactTags\": [\n \"<string>\"\n ],\n \"campaignInboxID\": \"<string>\",\n \"campaignMeta\": {},\n \"campaignModelID\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"campaignPluginConnectionID\": \"<string>\",\n \"campaignSessionTags\": [\n \"<string>\"\n ],\n \"campaignTag\": \"<string>\",\n \"dispatchAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignContactAttributes\": [\n \"<unknown>\"\n ],\n \"campaignContactIDs\": [\n \"<string>\"\n ],\n \"campaignContactTags\": [\n \"<string>\"\n ],\n \"campaignInboxID\": \"<string>\",\n \"campaignMeta\": {},\n \"campaignModelID\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"campaignPluginConnectionID\": \"<string>\",\n \"campaignSessionTags\": [\n \"<string>\"\n ],\n \"campaignTag\": \"<string>\",\n \"dispatchAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"campaignChannel": "urn:talqui:whatsapp-gup:0",
"campaignContactAttributes": [
"<unknown>"
],
"campaignContactIDs": [
"<string>"
],
"campaignContactTags": [
"<string>"
],
"campaignID": "<string>",
"campaignInboxID": "<string>",
"campaignMeta": {},
"campaignModelID": "<string>",
"campaignName": "<string>",
"campaignPluginConnectionID": "<string>",
"campaignSessionTags": [
"<string>"
],
"campaignSessionType": "auto",
"campaignStatus": "draft",
"campaignTag": "<string>",
"campaignVariables": "<unknown>",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"dispatchAt": "2023-11-07T05:31:56Z",
"organizationID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"campaignMetrics": {
"pending": 123,
"sended": 123,
"total": 123
}
}
}{
"errors": [
{
"error": "MissingTenantIDError",
"error_code": 1001,
"message": "tenantID is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "UnauthorizedError",
"error_code": 1003,
"message": "You are not authorized to perform this request.",
"statusCode": 401
}
]
}{
"errors": [
{
"error": "ForbiddenError",
"error_code": 1004,
"message": "You do not have access to this resource.",
"statusCode": 403
}
]
}{
"errors": [
{
"error": "CampaignNotFoundError",
"error_code": 1740,
"message": "Campaign not found.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "CampaignNotEditableError",
"error_code": 1742,
"message": "This campaign can no longer have its recipients, model or schedule changed.",
"statusCode": 422
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Campaigns
Update campaign
Updates a campaign’s metadata and/or (draft-only) recipients/model/
schedule. Changing campaignContactIDs, campaignContactAttributes,
campaignModelID or dispatchAt is rejected once the campaign has left
draft — the legacy campaignUpdate.js has no such guard.
PATCH
/
v1
/
tenants
/
{tenantID}
/
campaigns
/
{campaignID}
Update campaign
curl --request PATCH \
--url https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaignContactAttributes": [
"<unknown>"
],
"campaignContactIDs": [
"<string>"
],
"campaignContactTags": [
"<string>"
],
"campaignInboxID": "<string>",
"campaignMeta": {},
"campaignModelID": "<string>",
"campaignName": "<string>",
"campaignPluginConnectionID": "<string>",
"campaignSessionTags": [
"<string>"
],
"campaignTag": "<string>",
"dispatchAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}"
payload = {
"campaignContactAttributes": ["<unknown>"],
"campaignContactIDs": ["<string>"],
"campaignContactTags": ["<string>"],
"campaignInboxID": "<string>",
"campaignMeta": {},
"campaignModelID": "<string>",
"campaignName": "<string>",
"campaignPluginConnectionID": "<string>",
"campaignSessionTags": ["<string>"],
"campaignTag": "<string>",
"dispatchAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaignContactAttributes: ['<unknown>'],
campaignContactIDs: ['<string>'],
campaignContactTags: ['<string>'],
campaignInboxID: '<string>',
campaignMeta: {},
campaignModelID: '<string>',
campaignName: '<string>',
campaignPluginConnectionID: '<string>',
campaignSessionTags: ['<string>'],
campaignTag: '<string>',
dispatchAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'campaignContactAttributes' => [
'<unknown>'
],
'campaignContactIDs' => [
'<string>'
],
'campaignContactTags' => [
'<string>'
],
'campaignInboxID' => '<string>',
'campaignMeta' => [
],
'campaignModelID' => '<string>',
'campaignName' => '<string>',
'campaignPluginConnectionID' => '<string>',
'campaignSessionTags' => [
'<string>'
],
'campaignTag' => '<string>',
'dispatchAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}"
payload := strings.NewReader("{\n \"campaignContactAttributes\": [\n \"<unknown>\"\n ],\n \"campaignContactIDs\": [\n \"<string>\"\n ],\n \"campaignContactTags\": [\n \"<string>\"\n ],\n \"campaignInboxID\": \"<string>\",\n \"campaignMeta\": {},\n \"campaignModelID\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"campaignPluginConnectionID\": \"<string>\",\n \"campaignSessionTags\": [\n \"<string>\"\n ],\n \"campaignTag\": \"<string>\",\n \"dispatchAt\": \"2023-11-07T05:31:56Z\"\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))
}HttpResponse<String> response = Unirest.patch("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"campaignContactAttributes\": [\n \"<unknown>\"\n ],\n \"campaignContactIDs\": [\n \"<string>\"\n ],\n \"campaignContactTags\": [\n \"<string>\"\n ],\n \"campaignInboxID\": \"<string>\",\n \"campaignMeta\": {},\n \"campaignModelID\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"campaignPluginConnectionID\": \"<string>\",\n \"campaignSessionTags\": [\n \"<string>\"\n ],\n \"campaignTag\": \"<string>\",\n \"dispatchAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignContactAttributes\": [\n \"<unknown>\"\n ],\n \"campaignContactIDs\": [\n \"<string>\"\n ],\n \"campaignContactTags\": [\n \"<string>\"\n ],\n \"campaignInboxID\": \"<string>\",\n \"campaignMeta\": {},\n \"campaignModelID\": \"<string>\",\n \"campaignName\": \"<string>\",\n \"campaignPluginConnectionID\": \"<string>\",\n \"campaignSessionTags\": [\n \"<string>\"\n ],\n \"campaignTag\": \"<string>\",\n \"dispatchAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"campaignChannel": "urn:talqui:whatsapp-gup:0",
"campaignContactAttributes": [
"<unknown>"
],
"campaignContactIDs": [
"<string>"
],
"campaignContactTags": [
"<string>"
],
"campaignID": "<string>",
"campaignInboxID": "<string>",
"campaignMeta": {},
"campaignModelID": "<string>",
"campaignName": "<string>",
"campaignPluginConnectionID": "<string>",
"campaignSessionTags": [
"<string>"
],
"campaignSessionType": "auto",
"campaignStatus": "draft",
"campaignTag": "<string>",
"campaignVariables": "<unknown>",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"dispatchAt": "2023-11-07T05:31:56Z",
"organizationID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"campaignMetrics": {
"pending": 123,
"sended": 123,
"total": 123
}
}
}{
"errors": [
{
"error": "MissingTenantIDError",
"error_code": 1001,
"message": "tenantID is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "UnauthorizedError",
"error_code": 1003,
"message": "You are not authorized to perform this request.",
"statusCode": 401
}
]
}{
"errors": [
{
"error": "ForbiddenError",
"error_code": 1004,
"message": "You do not have access to this resource.",
"statusCode": 403
}
]
}{
"errors": [
{
"error": "CampaignNotFoundError",
"error_code": 1740,
"message": "Campaign not found.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "CampaignNotEditableError",
"error_code": 1742,
"message": "This campaign can no longer have its recipients, model or schedule changed.",
"statusCode": 422
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Authorizations
Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.
Body
application/json
Maximum array length:
3Show child attributes
Show child attributes
Minimum string length:
1Maximum array length:
3Available options:
auto, queued Response
Response for status 200.
The updated campaign.
Show child attributes
Show child attributes
⌘I