Update a task

PATCH

tasks

{task_id}

Update a task

curl --request PATCH \
  --url https://answeringagent.com/api/v1/tasks/{task_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "done",
  "assigned_to": 9034,
  "expected_status": "open"
}
'

import requests

url = "https://answeringagent.com/api/v1/tasks/{task_id}"

payload = {
    "status": "done",
    "assigned_to": 9034,
    "expected_status": "open"
}
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({status: 'done', assigned_to: 9034, expected_status: 'open'})
};

fetch('https://answeringagent.com/api/v1/tasks/{task_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://answeringagent.com/api/v1/tasks/{task_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([
    'status' => 'done',
    'assigned_to' => 9034,
    'expected_status' => 'open'
  ]),
  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://answeringagent.com/api/v1/tasks/{task_id}"

	payload := strings.NewReader("{\n  \"status\": \"done\",\n  \"assigned_to\": 9034,\n  \"expected_status\": \"open\"\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://answeringagent.com/api/v1/tasks/{task_id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"done\",\n  \"assigned_to\": 9034,\n  \"expected_status\": \"open\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://answeringagent.com/api/v1/tasks/{task_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  \"status\": \"done\",\n  \"assigned_to\": 9034,\n  \"expected_status\": \"open\"\n}"

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

{
  "id": "conversation-184532",
  "url": "https://answeringagent.com/dashboard/conversations/184532",
  "title": "<string>",
  "status": "open",
  "assignee": {
    "id": 9034,
    "name": "Priya Shah"
  },
  "category": "cancellation",
  "priority": "low",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "name": "Dana Ruiz",
    "phone": "+15125550118",
    "email": "dana.ruiz@example.com"
  },
  "conversation": {
    "id": 184532,
    "url": "<string>",
    "channel": "phone",
    "phone_line": {
      "id": 2181,
      "name": "Westside Wash",
      "phone_number": "+15125550142"
    }
  },
  "form": {
    "title": "<string>"
  },
  "description": "<string>"
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "This conversation was merged into conversation-184519. Use that task.",
  "code": "not_found"
}

{
  "error": "This endpoint accepts GET.",
  "code": "method_not_allowed"
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

task_id

string

required

Pattern: ^(conversation|form-submission)-\d+$

Example:

"conversation-184532"

Body

application/json

status

enum<string>

Available options:

open,

in_progress,

on_hold,

done

assigned_to

integer | null

A team member id, from a task's assignee.id or members[].id in GET /account. Null unassigns.

expected_status

enum<string>

Apply only if the task still has this status. A task that never had a status counts as open.

Available options:

open,

in_progress,

on_hold,

done

expected_assigned_to

integer | null

Apply only if the task still has this assignee.

Response

The updated task. When the change takes the task out of what the key can see, the change is saved and the body is only id, status, assignee, and visible false.

Option 1
Option 2

string

Example:

"conversation-184532"

url

string

Example:

"https://answeringagent.com/dashboard/conversations/184532"

title

string | null

status

enum<string>

Available options:

open,

in_progress,

on_hold,

done

assignee

object

A team member. The id is what assigned_to and report filters.team_member_ids take.

Option 1
Option 2

Show child attributes

category

A category key. Conversations, tasks, and reports share one list. A form task has form. GET /reports/metrics lists every key with its label under categories. Older records can have a retired key that is not in that list.

Example:

"cancellation"

priority

enum<string>

Available options:

low,

medium,

high,

urgent,

normal

created_at

string<date-time> | null

When the source conversation started or the form was submitted. Not when the AI created the task.

customer

object

From the conversation's contact, or from the form submission for a form task.

Show child attributes

conversation

object | null

Show child attributes

form

object | null

Show child attributes

description

string | null

Maximum string length: 5000

Update a task

curl --request PATCH \
  --url https://answeringagent.com/api/v1/tasks/{task_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "done",
  "assigned_to": 9034,
  "expected_status": "open"
}
'

import requests

url = "https://answeringagent.com/api/v1/tasks/{task_id}"

payload = {
    "status": "done",
    "assigned_to": 9034,
    "expected_status": "open"
}
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({status: 'done', assigned_to: 9034, expected_status: 'open'})
};

fetch('https://answeringagent.com/api/v1/tasks/{task_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://answeringagent.com/api/v1/tasks/{task_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([
    'status' => 'done',
    'assigned_to' => 9034,
    'expected_status' => 'open'
  ]),
  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://answeringagent.com/api/v1/tasks/{task_id}"

	payload := strings.NewReader("{\n  \"status\": \"done\",\n  \"assigned_to\": 9034,\n  \"expected_status\": \"open\"\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://answeringagent.com/api/v1/tasks/{task_id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"done\",\n  \"assigned_to\": 9034,\n  \"expected_status\": \"open\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://answeringagent.com/api/v1/tasks/{task_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  \"status\": \"done\",\n  \"assigned_to\": 9034,\n  \"expected_status\": \"open\"\n}"

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

{
  "id": "conversation-184532",
  "url": "https://answeringagent.com/dashboard/conversations/184532",
  "title": "<string>",
  "status": "open",
  "assignee": {
    "id": 9034,
    "name": "Priya Shah"
  },
  "category": "cancellation",
  "priority": "low",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "name": "Dana Ruiz",
    "phone": "+15125550118",
    "email": "dana.ruiz@example.com"
  },
  "conversation": {
    "id": 184532,
    "url": "<string>",
    "channel": "phone",
    "phone_line": {
      "id": 2181,
      "name": "Westside Wash",
      "phone_number": "+15125550142"
    }
  },
  "form": {
    "title": "<string>"
  },
  "description": "<string>"
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "This conversation was merged into conversation-184519. Use that task.",
  "code": "not_found"
}

{
  "error": "This endpoint accepts GET.",
  "code": "method_not_allowed"
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "That conversation is not available.",
  "code": "not_found",
  "issues": [
    {
      "path": [
        "<unknown>"
      ],
      "message": "<string>"
    }
  ]
}

Get started

Endpoints

Webhooks

Guides

API playground

Authorizations

Path Parameters

Body

Response