Skip to main content
POST
/
v3
/
contacts
/
set-bounced
Mark or unmark contacts as bounced
curl --request POST \
  --url https://api.reply.io/v3/contacts/set-bounced \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactIds": [
    123
  ],
  "isBounced": true,
  "resendEmails": true
}
'
import requests

url = "https://api.reply.io/v3/contacts/set-bounced"

payload = {
    "contactIds": [123],
    "isBounced": True,
    "resendEmails": 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({contactIds: [123], isBounced: true, resendEmails: true})
};

fetch('https://api.reply.io/v3/contacts/set-bounced', 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.reply.io/v3/contacts/set-bounced",
  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([
    'contactIds' => [
        123
    ],
    'isBounced' => true,
    'resendEmails' => 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.reply.io/v3/contacts/set-bounced"

	payload := strings.NewReader("{\n  \"contactIds\": [\n    123\n  ],\n  \"isBounced\": true,\n  \"resendEmails\": 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.reply.io/v3/contacts/set-bounced")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contactIds\": [\n    123\n  ],\n  \"isBounced\": true,\n  \"resendEmails\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.reply.io/v3/contacts/set-bounced")

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  \"contactIds\": [\n    123\n  ],\n  \"isBounced\": true,\n  \"resendEmails\": true\n}"

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

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Body

application/json
contactIds
integer[]
required

Contact IDs to update. At least one, at most 100. Each ID must be positive.

Required array length: 1 - 100 elements
isBounced
boolean
required

true marks the contacts as bounced; false clears the bounced flag.

resendEmails
boolean | null

Required (non-null) when isBounced=false; must be omitted when isBounced=true. When true, the previously bounced step is rescheduled for retry.

Response

Non-atomic result. The response body is a dictionary keyed by contact id listing per-item failures. Empty object {} means all contacts were updated successfully.

Per-item failures use the ContactError enum. Common per-item slugs:

SlugMeaning
notFoundContact does not exist
forbiddenCaller lacks permission for this contact
sequenceNotFoundDerived sequence not accessible
invalidInputValue rejected for this contact

Dictionary of per-item failures keyed by contact id. Empty object {} means all succeeded.

{key}
NotProcessedItemResult · object

Per-item error for non-atomic bulk operations. Only failed items are returned in the response dictionary. Items not present in the dictionary succeeded.