curl --request PATCH \
--url https://client-api.salesfinity.co/v2/sequencer/tasks/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "507f1f77bcf86cd799439011",
"due_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"note": "<string>"
}
'import requests
url = "https://client-api.salesfinity.co/v2/sequencer/tasks/{id}"
payload = {
"user_id": "507f1f77bcf86cd799439011",
"due_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"note": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '507f1f77bcf86cd799439011',
due_at: '2023-11-07T05:31:56Z',
subject: '<string>',
note: '<string>'
})
};
fetch('https://client-api.salesfinity.co/v2/sequencer/tasks/{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://client-api.salesfinity.co/v2/sequencer/tasks/{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([
'user_id' => '507f1f77bcf86cd799439011',
'due_at' => '2023-11-07T05:31:56Z',
'subject' => '<string>',
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://client-api.salesfinity.co/v2/sequencer/tasks/{id}"
payload := strings.NewReader("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"subject\": \"<string>\",\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://client-api.salesfinity.co/v2/sequencer/tasks/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"subject\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v2/sequencer/tasks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"subject\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"user": "<string>",
"contact": "507f1f77bcf86cd799439011",
"sequence": "<string>",
"sequence_step": "<string>",
"origin": "sequence",
"action": "call",
"state": "pending",
"priority": "high",
"subject": "<string>",
"note": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"autoskip_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"call_log": "<string>"
}{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Not found",
"error": "Not Found",
"statusCode": 404
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Update a one-off task
One-off tasks only. A cadence task’s shape belongs to its step — snooze it, or un-enrol the contact, instead.
curl --request PATCH \
--url https://client-api.salesfinity.co/v2/sequencer/tasks/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "507f1f77bcf86cd799439011",
"due_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"note": "<string>"
}
'import requests
url = "https://client-api.salesfinity.co/v2/sequencer/tasks/{id}"
payload = {
"user_id": "507f1f77bcf86cd799439011",
"due_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"note": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '507f1f77bcf86cd799439011',
due_at: '2023-11-07T05:31:56Z',
subject: '<string>',
note: '<string>'
})
};
fetch('https://client-api.salesfinity.co/v2/sequencer/tasks/{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://client-api.salesfinity.co/v2/sequencer/tasks/{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([
'user_id' => '507f1f77bcf86cd799439011',
'due_at' => '2023-11-07T05:31:56Z',
'subject' => '<string>',
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://client-api.salesfinity.co/v2/sequencer/tasks/{id}"
payload := strings.NewReader("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"subject\": \"<string>\",\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://client-api.salesfinity.co/v2/sequencer/tasks/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"subject\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v2/sequencer/tasks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"due_at\": \"2023-11-07T05:31:56Z\",\n \"subject\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"user": "<string>",
"contact": "507f1f77bcf86cd799439011",
"sequence": "<string>",
"sequence_step": "<string>",
"origin": "sequence",
"action": "call",
"state": "pending",
"priority": "high",
"subject": "<string>",
"note": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"autoskip_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"call_log": "<string>"
}{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Not found",
"error": "Not Found",
"statusCode": 404
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.
Path Parameters
24-character task id.
Body
The team member this call acts as. Must be an active member of the team the API key belongs to.
"507f1f77bcf86cd799439011"
ISO 8601, and must be in the future. Values more than 365 days out are rejected, and so is a value already in the past — with a few minutes of slack, so a client computing "now" is not caught out by its own request latency.
high, medium, low Response
Success.
A task in a rep queue.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
Assignee.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
Absent on a one-off task.
sequence, one_off call, manual_email, generic, linkedin_connect, linkedin_message, linkedin_view, linkedin_interact, meeting, sms pending, held, completed, skipped, expired, cancelled high, medium, low When the task is due.
Set when a call task was resolved by a logged call.