Patch Email Batch

curl --request PATCH \
  --url https://api.in.talqing.com/v1/email/batches/{batch_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calling_window": {
    "end": "<string>",
    "start": "<string>",
    "days": [
      1,
      2,
      3,
      4,
      5,
      6,
      7
    ]
  },
  "field_map": {
    "body": "<string>",
    "subject": "<string>",
    "to": "<string>"
  },
  "from_email": "<string>",
  "from_name": "<string>",
  "max_attempts": 3,
  "max_concurrency": 5,
  "name": "<string>",
  "reply_to": "<string>",
  "retry_after_minutes": 722,
  "send_sleep_seconds": 30,
  "start_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>"
}
'

import requests

url = "https://api.in.talqing.com/v1/email/batches/{batch_id}"

payload = {
    "calling_window": {
        "end": "<string>",
        "start": "<string>",
        "days": [1, 2, 3, 4, 5, 6, 7]
    },
    "field_map": {
        "body": "<string>",
        "subject": "<string>",
        "to": "<string>"
    },
    "from_email": "<string>",
    "from_name": "<string>",
    "max_attempts": 3,
    "max_concurrency": 5,
    "name": "<string>",
    "reply_to": "<string>",
    "retry_after_minutes": 722,
    "send_sleep_seconds": 30,
    "start_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>"
}
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({
    calling_window: {end: '<string>', start: '<string>', days: [1, 2, 3, 4, 5, 6, 7]},
    field_map: {body: JSON.stringify('<string>'), subject: '<string>', to: '<string>'},
    from_email: '<string>',
    from_name: '<string>',
    max_attempts: 3,
    max_concurrency: 5,
    name: '<string>',
    reply_to: '<string>',
    retry_after_minutes: 722,
    send_sleep_seconds: 30,
    start_at: '2023-11-07T05:31:56Z',
    timezone: '<string>'
  })
};

fetch('https://api.in.talqing.com/v1/email/batches/{batch_id}', 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.in.talqing.com/v1/email/batches/{batch_id}",
  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([
    'calling_window' => [
        'end' => '<string>',
        'start' => '<string>',
        'days' => [
                1,
                2,
                3,
                4,
                5,
                6,
                7
        ]
    ],
    'field_map' => [
        'body' => '<string>',
        'subject' => '<string>',
        'to' => '<string>'
    ],
    'from_email' => '<string>',
    'from_name' => '<string>',
    'max_attempts' => 3,
    'max_concurrency' => 5,
    'name' => '<string>',
    'reply_to' => '<string>',
    'retry_after_minutes' => 722,
    'send_sleep_seconds' => 30,
    'start_at' => '2023-11-07T05:31:56Z',
    'timezone' => '<string>'
  ]),
  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://api.in.talqing.com/v1/email/batches/{batch_id}"

	payload := strings.NewReader("{\n  \"calling_window\": {\n    \"end\": \"<string>\",\n    \"start\": \"<string>\",\n    \"days\": [\n      1,\n      2,\n      3,\n      4,\n      5,\n      6,\n      7\n    ]\n  },\n  \"field_map\": {\n    \"body\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"from_email\": \"<string>\",\n  \"from_name\": \"<string>\",\n  \"max_attempts\": 3,\n  \"max_concurrency\": 5,\n  \"name\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"retry_after_minutes\": 722,\n  \"send_sleep_seconds\": 30,\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\"\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://api.in.talqing.com/v1/email/batches/{batch_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calling_window\": {\n    \"end\": \"<string>\",\n    \"start\": \"<string>\",\n    \"days\": [\n      1,\n      2,\n      3,\n      4,\n      5,\n      6,\n      7\n    ]\n  },\n  \"field_map\": {\n    \"body\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"from_email\": \"<string>\",\n  \"from_name\": \"<string>\",\n  \"max_attempts\": 3,\n  \"max_concurrency\": 5,\n  \"name\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"retry_after_minutes\": 722,\n  \"send_sleep_seconds\": 30,\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.in.talqing.com/v1/email/batches/{batch_id}")

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  \"calling_window\": {\n    \"end\": \"<string>\",\n    \"start\": \"<string>\",\n    \"days\": [\n      1,\n      2,\n      3,\n      4,\n      5,\n      6,\n      7\n    ]\n  },\n  \"field_map\": {\n    \"body\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"from_email\": \"<string>\",\n  \"from_name\": \"<string>\",\n  \"max_attempts\": 3,\n  \"max_concurrency\": 5,\n  \"name\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"retry_after_minutes\": 722,\n  \"send_sleep_seconds\": 30,\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\"\n}"

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

{
  "body_format": "text",
  "calling_window": {
    "end": "<string>",
    "start": "<string>",
    "days": [
      1,
      2,
      3,
      4,
      5,
      6,
      7
    ]
  },
  "counts": {
    "canceled": 123,
    "draft": 123,
    "draft_failed": 123,
    "drafting": 123,
    "pending": 123,
    "queued": 123,
    "send_failed": 123,
    "sending": 123,
    "sent": 123,
    "skipped": 123,
    "total": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "drafted_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "field_map": {
    "body": "<string>",
    "subject": "<string>",
    "to": "<string>"
  },
  "from_email": "<string>",
  "from_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_columns": [
    "<string>"
  ],
  "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration_name": "<string>",
  "max_attempts": 123,
  "max_concurrency": 123,
  "name": "<string>",
  "next_draft_at": "2023-11-07T05:31:56Z",
  "output_columns": [
    "<string>"
  ],
  "provider_cost": 123,
  "reply_to": "<string>",
  "retry_after_minutes": 123,
  "send_sleep_seconds": 123,
  "start_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "status": "scheduled",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_name": "<string>",
  "timezone": "<string>"
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

PATCH

batches

{batch_id}

Patch Email Batch

curl --request PATCH \
  --url https://api.in.talqing.com/v1/email/batches/{batch_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calling_window": {
    "end": "<string>",
    "start": "<string>",
    "days": [
      1,
      2,
      3,
      4,
      5,
      6,
      7
    ]
  },
  "field_map": {
    "body": "<string>",
    "subject": "<string>",
    "to": "<string>"
  },
  "from_email": "<string>",
  "from_name": "<string>",
  "max_attempts": 3,
  "max_concurrency": 5,
  "name": "<string>",
  "reply_to": "<string>",
  "retry_after_minutes": 722,
  "send_sleep_seconds": 30,
  "start_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>"
}
'

import requests

url = "https://api.in.talqing.com/v1/email/batches/{batch_id}"

payload = {
    "calling_window": {
        "end": "<string>",
        "start": "<string>",
        "days": [1, 2, 3, 4, 5, 6, 7]
    },
    "field_map": {
        "body": "<string>",
        "subject": "<string>",
        "to": "<string>"
    },
    "from_email": "<string>",
    "from_name": "<string>",
    "max_attempts": 3,
    "max_concurrency": 5,
    "name": "<string>",
    "reply_to": "<string>",
    "retry_after_minutes": 722,
    "send_sleep_seconds": 30,
    "start_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>"
}
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({
    calling_window: {end: '<string>', start: '<string>', days: [1, 2, 3, 4, 5, 6, 7]},
    field_map: {body: JSON.stringify('<string>'), subject: '<string>', to: '<string>'},
    from_email: '<string>',
    from_name: '<string>',
    max_attempts: 3,
    max_concurrency: 5,
    name: '<string>',
    reply_to: '<string>',
    retry_after_minutes: 722,
    send_sleep_seconds: 30,
    start_at: '2023-11-07T05:31:56Z',
    timezone: '<string>'
  })
};

fetch('https://api.in.talqing.com/v1/email/batches/{batch_id}', 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.in.talqing.com/v1/email/batches/{batch_id}",
  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([
    'calling_window' => [
        'end' => '<string>',
        'start' => '<string>',
        'days' => [
                1,
                2,
                3,
                4,
                5,
                6,
                7
        ]
    ],
    'field_map' => [
        'body' => '<string>',
        'subject' => '<string>',
        'to' => '<string>'
    ],
    'from_email' => '<string>',
    'from_name' => '<string>',
    'max_attempts' => 3,
    'max_concurrency' => 5,
    'name' => '<string>',
    'reply_to' => '<string>',
    'retry_after_minutes' => 722,
    'send_sleep_seconds' => 30,
    'start_at' => '2023-11-07T05:31:56Z',
    'timezone' => '<string>'
  ]),
  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://api.in.talqing.com/v1/email/batches/{batch_id}"

	payload := strings.NewReader("{\n  \"calling_window\": {\n    \"end\": \"<string>\",\n    \"start\": \"<string>\",\n    \"days\": [\n      1,\n      2,\n      3,\n      4,\n      5,\n      6,\n      7\n    ]\n  },\n  \"field_map\": {\n    \"body\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"from_email\": \"<string>\",\n  \"from_name\": \"<string>\",\n  \"max_attempts\": 3,\n  \"max_concurrency\": 5,\n  \"name\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"retry_after_minutes\": 722,\n  \"send_sleep_seconds\": 30,\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\"\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://api.in.talqing.com/v1/email/batches/{batch_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calling_window\": {\n    \"end\": \"<string>\",\n    \"start\": \"<string>\",\n    \"days\": [\n      1,\n      2,\n      3,\n      4,\n      5,\n      6,\n      7\n    ]\n  },\n  \"field_map\": {\n    \"body\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"from_email\": \"<string>\",\n  \"from_name\": \"<string>\",\n  \"max_attempts\": 3,\n  \"max_concurrency\": 5,\n  \"name\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"retry_after_minutes\": 722,\n  \"send_sleep_seconds\": 30,\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.in.talqing.com/v1/email/batches/{batch_id}")

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  \"calling_window\": {\n    \"end\": \"<string>\",\n    \"start\": \"<string>\",\n    \"days\": [\n      1,\n      2,\n      3,\n      4,\n      5,\n      6,\n      7\n    ]\n  },\n  \"field_map\": {\n    \"body\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"from_email\": \"<string>\",\n  \"from_name\": \"<string>\",\n  \"max_attempts\": 3,\n  \"max_concurrency\": 5,\n  \"name\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"retry_after_minutes\": 722,\n  \"send_sleep_seconds\": 30,\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\"\n}"

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

{
  "body_format": "text",
  "calling_window": {
    "end": "<string>",
    "start": "<string>",
    "days": [
      1,
      2,
      3,
      4,
      5,
      6,
      7
    ]
  },
  "counts": {
    "canceled": 123,
    "draft": 123,
    "draft_failed": 123,
    "drafting": 123,
    "pending": 123,
    "queued": 123,
    "send_failed": 123,
    "sending": 123,
    "sent": 123,
    "skipped": 123,
    "total": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "drafted_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "field_map": {
    "body": "<string>",
    "subject": "<string>",
    "to": "<string>"
  },
  "from_email": "<string>",
  "from_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_columns": [
    "<string>"
  ],
  "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration_name": "<string>",
  "max_attempts": 123,
  "max_concurrency": 123,
  "name": "<string>",
  "next_draft_at": "2023-11-07T05:31:56Z",
  "output_columns": [
    "<string>"
  ],
  "provider_cost": 123,
  "reply_to": "<string>",
  "retry_after_minutes": 123,
  "send_sleep_seconds": 123,
  "start_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "status": "scheduled",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_name": "<string>",
  "timezone": "<string>"
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

{
  "detail": {
    "errors": [
      "<string>"
    ],
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id

string<uuid>

required

Body

application/json

Policy edits.

calling_window and start_at accept an explicit null to clear them — "draft at any hour", "start on the next pass" — which is why the service reads model_fields_set rather than treating absent and null the same way. Every other field keeps the usual PATCH rule: absent means unchanged.

Pacing stays editable at any time; identity does not once anything has been sent (see service.patch_batch).

body_format

enum<string> | null

Available options:

text,

html

calling_window

CallingWindow · object | null

The hours a batch may dial in, on the batch's own clock.

A window that crosses midnight (21:00–06:00) is valid and means exactly what an evening consumer-calling window means: the day check applies to the start side, so 21:00–06:00 on days: [5] runs Friday 21:00 through Saturday 06:00.

Show child attributes

field_map

FieldMap · object | null

Which column in the merged space carries each of the three sent fields.

A value may name a CSV header or an output field of the task — that is the whole point of the merged space, and it is what makes "the CSV has emails" and "feed it a phone number and let the task find the email" the same feature.

Show child attributes

from_email

string | null

from_name

string | null

Maximum string length: 200

max_attempts

integer | null

Required range: 1 <= x <= 5

max_concurrency

integer | null

Required range: 1 <= x <= 10

name

string | null

Required string length: 1 - 200

reply_to

string | null

retry_after_minutes

integer | null

Required range: 5 <= x <= 1440

send_sleep_seconds

integer | null

Required range: 1 <= x <= 60

start_at

string<date-time> | null

timezone

string | null

Response

Successful Response

body_format

enum<string>

required

Available options:

text,

html

calling_window

CallingWindow · object | null

required

The hours a batch may dial in, on the batch's own clock.

Show child attributes

counts

EmailBatchCounts · object

required

Show child attributes

created_at

string<date-time>

required

drafted_at

string<date-time> | null

required

failure_reason

string | null

required

field_map

FieldMap · object

required

Which column in the merged space carries each of the three sent fields.

Show child attributes

from_email

string

required

from_name

string | null

required

string<uuid>

required

input_columns

string[]

required

integration_id

string<uuid> | null

required

integration_name

string | null

required

max_attempts

integer

required

max_concurrency

integer

required

name

string

required

next_draft_at

string<date-time> | null

required

output_columns

string[]

required

provider_cost

number | null

required

reply_to

string | null

required

retry_after_minutes

integer

required

send_sleep_seconds

integer

required

start_at

string<date-time> | null

required

started_at

string<date-time> | null

required

status

enum<string>

required

Available options:

scheduled,

drafting,

paused,

drafted,

canceled,

failed

task_id

string<uuid> | null

required

task_name

string | null

required

timezone

string

required

Using the API

Endpoints

Patch Email Batch

Authorizations

Path Parameters

Body

Response