Schedule campaign

curl --request POST \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispatchAt": "2023-11-07T05:31:56Z",
  "excludedContactIDs": [
    "<string>"
  ],
  "filters": [],
  "importedContactIDs": [
    "<string>"
  ],
  "manualContactIDs": [
    "<string>"
  ],
  "variableConfigs": {}
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule"

payload = {
    "dispatchAt": "2023-11-07T05:31:56Z",
    "excludedContactIDs": ["<string>"],
    "filters": [],
    "importedContactIDs": ["<string>"],
    "manualContactIDs": ["<string>"],
    "variableConfigs": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dispatchAt: '2023-11-07T05:31:56Z',
    excludedContactIDs: ['<string>'],
    filters: [],
    importedContactIDs: ['<string>'],
    manualContactIDs: ['<string>'],
    variableConfigs: {}
  })
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule', 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}/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dispatchAt' => '2023-11-07T05:31:56Z',
    'excludedContactIDs' => [
        '<string>'
    ],
    'filters' => [
        
    ],
    'importedContactIDs' => [
        '<string>'
    ],
    'manualContactIDs' => [
        '<string>'
    ],
    'variableConfigs' => [
        
    ]
  ]),
  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}/schedule"

	payload := strings.NewReader("{\n  \"dispatchAt\": \"2023-11-07T05:31:56Z\",\n  \"excludedContactIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [],\n  \"importedContactIDs\": [\n    \"<string>\"\n  ],\n  \"manualContactIDs\": [\n    \"<string>\"\n  ],\n  \"variableConfigs\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dispatchAt\": \"2023-11-07T05:31:56Z\",\n  \"excludedContactIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [],\n  \"importedContactIDs\": [\n    \"<string>\"\n  ],\n  \"manualContactIDs\": [\n    \"<string>\"\n  ],\n  \"variableConfigs\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dispatchAt\": \"2023-11-07T05:31:56Z\",\n  \"excludedContactIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [],\n  \"importedContactIDs\": [\n    \"<string>\"\n  ],\n  \"manualContactIDs\": [\n    \"<string>\"\n  ],\n  \"variableConfigs\": {}\n}"

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

{
  "campaignID": "<string>",
  "campaignStatus": "<string>",
  "enqueueFailedCount": 123,
  "enqueuedCount": 123,
  "totalContacts": 123,
  "unresolvedCount": 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": "CampaignNotAllowScheduleError",
      "error_code": 1760,
      "message": "Only draft campaigns can be scheduled.",
      "statusCode": 422
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

POST

tenants

{tenantID}

campaigns

{campaignID}

schedule

Schedule campaign

curl --request POST \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispatchAt": "2023-11-07T05:31:56Z",
  "excludedContactIDs": [
    "<string>"
  ],
  "filters": [],
  "importedContactIDs": [
    "<string>"
  ],
  "manualContactIDs": [
    "<string>"
  ],
  "variableConfigs": {}
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule"

payload = {
    "dispatchAt": "2023-11-07T05:31:56Z",
    "excludedContactIDs": ["<string>"],
    "filters": [],
    "importedContactIDs": ["<string>"],
    "manualContactIDs": ["<string>"],
    "variableConfigs": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dispatchAt: '2023-11-07T05:31:56Z',
    excludedContactIDs: ['<string>'],
    filters: [],
    importedContactIDs: ['<string>'],
    manualContactIDs: ['<string>'],
    variableConfigs: {}
  })
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule', 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}/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dispatchAt' => '2023-11-07T05:31:56Z',
    'excludedContactIDs' => [
        '<string>'
    ],
    'filters' => [
        
    ],
    'importedContactIDs' => [
        '<string>'
    ],
    'manualContactIDs' => [
        '<string>'
    ],
    'variableConfigs' => [
        
    ]
  ]),
  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}/schedule"

	payload := strings.NewReader("{\n  \"dispatchAt\": \"2023-11-07T05:31:56Z\",\n  \"excludedContactIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [],\n  \"importedContactIDs\": [\n    \"<string>\"\n  ],\n  \"manualContactIDs\": [\n    \"<string>\"\n  ],\n  \"variableConfigs\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dispatchAt\": \"2023-11-07T05:31:56Z\",\n  \"excludedContactIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [],\n  \"importedContactIDs\": [\n    \"<string>\"\n  ],\n  \"manualContactIDs\": [\n    \"<string>\"\n  ],\n  \"variableConfigs\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/schedule")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dispatchAt\": \"2023-11-07T05:31:56Z\",\n  \"excludedContactIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [],\n  \"importedContactIDs\": [\n    \"<string>\"\n  ],\n  \"manualContactIDs\": [\n    \"<string>\"\n  ],\n  \"variableConfigs\": {}\n}"

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

{
  "campaignID": "<string>",
  "campaignStatus": "<string>",
  "enqueueFailedCount": 123,
  "enqueuedCount": 123,
  "totalContacts": 123,
  "unresolvedCount": 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": "CampaignNotAllowScheduleError",
      "error_code": 1760,
      "message": "Only draft campaigns can be scheduled.",
      "statusCode": 422
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Authorizations

Authorization

string

header

required

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>.

Path Parameters

tenantID

string

required

campaignID

string

required

Body

application/json

dispatchAt

string<date-time> | null

When to start dispatching: ISO 8601 datetime with offset or Z. Omit/null for immediate dispatch; a value more than 5 minutes in the past is rejected.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

excludedContactIDs

string[]

Contacts explicitly removed from the final audience.

filters

object[]

Segment rules to resolve into recipients — same wire format as /contacts/segment.

Show child attributes

importedContactIDs

string[]

Contacts resolved from a CSV import.

manualContactIDs

string[]

Contacts picked manually by the operator.

variableConfigs

object

Value source per template variable key (from the campaign model catalog) — fixed or per-contact.

Show child attributes

Response

Response for status 200.

campaignID

string

required

campaignStatus

string

required

enqueueFailedCount

number

required

Dispatches left pending for the watchdog poller to pick up (queue publish failed or unconfigured).

enqueuedCount

number

required

Dispatches successfully published to SQS in this request.

totalContacts

number

required

unresolvedCount

number

required

Recipients recorded as failed because a required template variable had no value for them.

⌘I

Real Time API

Services API

Helpdesk API

Schedule campaign

Authorizations

Path Parameters

Body

Response