Update Conversation Statuses

POST

api

conversations

bulk

status

Update Conversation Statuses

curl --request POST \
  --url https://api.sequenzy.com/api/v1/conversations/bulk/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationIds": [
    "<string>"
  ],
  "status": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/conversations/bulk/status"

payload = {
    "conversationIds": ["<string>"],
    "status": "<string>"
}
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({conversationIds: ['<string>'], status: '<string>'})
};

fetch('https://api.sequenzy.com/api/v1/conversations/bulk/status', 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.sequenzy.com/api/v1/conversations/bulk/status",
  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([
    'conversationIds' => [
        '<string>'
    ],
    'status' => '<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.sequenzy.com/api/v1/conversations/bulk/status"

	payload := strings.NewReader("{\n  \"conversationIds\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\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://api.sequenzy.com/api/v1/conversations/bulk/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversationIds\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/conversations/bulk/status")

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  \"conversationIds\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}"

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

{
  "success": true,
  "status": "closed",
  "requested": 3,
  "updated": 1,
  "unchanged": 1,
  "notFound": 1,
  "updatedIds": ["conv_abc123"],
  "unchangedIds": ["conv_def456"],
  "notFoundIds": ["conv_missing"]
}

{
  "error": "Provide at least one conversation ID"
}

{
  "error": "Provide at most 100 conversation IDs"
}

{
  "type": "validation",
  "on": "body",
  "property": "/status",
  "message": "Expected union value",
  "summary": "Property 'status' must be one of: open, closed"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: conversations:write"
}

Open or close several conversations at once, for example every conversation on one page of List Conversations. Only conversations whose status changes are updated, so you can safely retry a request after a timeout: conversations that already have the status are reported as unchanged. Closed conversations are reopened automatically when the subscriber replies or when you send a new outbound message.

Request

string[]

required

Conversation IDs to update, up to 100 distinct IDs. Surrounding whitespace is trimmed, and blank or repeated IDs are ignored before the limit is checked. At least one non-blank ID is required.

string

required

New status for every listed conversation: open or closed.

curl -X POST "https://api.sequenzy.com/api/v1/conversations/bulk/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"conversationIds": ["conv_abc123", "conv_def456", "conv_missing"], "status": "closed"}'

Response

boolean

true when the request was processed.

string

The status that was applied: open or closed.

integer

Number of distinct conversation IDs in the request.

integer

Number of conversations whose status changed.

integer

Number of conversations that already had the status.

integer

Number of IDs that do not exist in your company. They are skipped; the rest of the request still applies.

string[]

IDs whose status changed, in request order.

string[]

IDs that already had the status, in request order.

string[]

IDs that do not exist in your company, in request order.

{
  "success": true,
  "status": "closed",
  "requested": 3,
  "updated": 1,
  "unchanged": 1,
  "notFound": 1,
  "updatedIds": ["conv_abc123"],
  "unchangedIds": ["conv_def456"],
  "notFoundIds": ["conv_missing"]
}

{
  "error": "Provide at least one conversation ID"
}

{
  "error": "Provide at most 100 conversation IDs"
}

{
  "type": "validation",
  "on": "body",
  "property": "/status",
  "message": "Expected union value",
  "summary": "Property 'status' must be one of: open, closed"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: conversations:write"
}

Requests whose conversationIds array has no usable IDs or more than 100 distinct IDs return 400. A missing or unknown status, or a missing or non-array conversationIds, returns 422. Rejected requests change no conversations. The API key needs the conversations:write scope.

Update Conversation Statuses

curl --request POST \
  --url https://api.sequenzy.com/api/v1/conversations/bulk/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationIds": [
    "<string>"
  ],
  "status": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/conversations/bulk/status"

payload = {
    "conversationIds": ["<string>"],
    "status": "<string>"
}
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({conversationIds: ['<string>'], status: '<string>'})
};

fetch('https://api.sequenzy.com/api/v1/conversations/bulk/status', 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.sequenzy.com/api/v1/conversations/bulk/status",
  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([
    'conversationIds' => [
        '<string>'
    ],
    'status' => '<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.sequenzy.com/api/v1/conversations/bulk/status"

	payload := strings.NewReader("{\n  \"conversationIds\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\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://api.sequenzy.com/api/v1/conversations/bulk/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversationIds\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/conversations/bulk/status")

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  \"conversationIds\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}"

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

{
  "success": true,
  "status": "closed",
  "requested": 3,
  "updated": 1,
  "unchanged": 1,
  "notFound": 1,
  "updatedIds": ["conv_abc123"],
  "unchangedIds": ["conv_def456"],
  "notFoundIds": ["conv_missing"]
}

{
  "error": "Provide at least one conversation ID"
}

{
  "error": "Provide at most 100 conversation IDs"
}

{
  "type": "validation",
  "on": "body",
  "property": "/status",
  "message": "Expected union value",
  "summary": "Property 'status' must be one of: open, closed"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: conversations:write"
}

​Request

​Response

Request

Response