Move Conversations to or from Spam

POST

api

conversations

bulk

spam

Move Conversations to or from Spam

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

import requests

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

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

fetch('https://api.sequenzy.com/api/v1/conversations/bulk/spam', 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/spam",
  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>'
    ],
    'spam' => true
  ]),
  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/spam"

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

require 'uri'
require 'net/http'

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

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  \"spam\": true\n}"

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

{
  "success": true,
  "spam": false,
  "requested": 2,
  "updated": 1,
  "unchanged": 0,
  "notFound": 1,
  "updatedIds": ["conv_abc123"],
  "unchangedIds": [],
  "notFoundIds": ["conv_missing"]
}

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

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

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

Move conversations into the Spam folder, or back to the inbox when the spam scan got it wrong. Mail sent to your inbox addresses that the inbound spam or virus scan flags already lands in Spam on its own. Spam conversations are left out of List Conversations unless you pass spam=true, and out of unread and open counts. Only conversations that move are updated, so you can safely retry a request after a timeout.

Request

string[]

required

Conversation IDs to move, 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.

boolean

required

true moves the conversations to Spam; false moves them back to the inbox.

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

Response

boolean

true when the request was processed.

boolean

Where the conversations were moved: true for Spam, false for the inbox.

integer

Number of distinct conversation IDs in the request.

integer

Number of conversations that moved.

integer

Number of conversations that were already there.

integer

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

string[]

IDs that moved, in request order.

string[]

IDs that were already there, in request order.

string[]

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

{
  "success": true,
  "spam": false,
  "requested": 2,
  "updated": 1,
  "unchanged": 0,
  "notFound": 1,
  "updatedIds": ["conv_abc123"],
  "unchangedIds": [],
  "notFoundIds": ["conv_missing"]
}

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

{
  "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 non-boolean spam, or a missing or non-array conversationIds, returns 422. Rejected requests change no conversations. The API key needs the conversations:write scope.

Move Conversations to or from Spam

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

import requests

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

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

fetch('https://api.sequenzy.com/api/v1/conversations/bulk/spam', 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/spam",
  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>'
    ],
    'spam' => true
  ]),
  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/spam"

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

require 'uri'
require 'net/http'

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

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  \"spam\": true\n}"

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

{
  "success": true,
  "spam": false,
  "requested": 2,
  "updated": 1,
  "unchanged": 0,
  "notFound": 1,
  "updatedIds": ["conv_abc123"],
  "unchangedIds": [],
  "notFoundIds": ["conv_missing"]
}

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

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

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

​Request

​Response

Request

Response