Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Update the reason or note of a suppression entry.
cURL
curl --request PATCH \ --url https://api.useinvent.com/orgs/suppressions/{suppression_id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "note": "<string>" } '
import requests url = "https://api.useinvent.com/orgs/suppressions/{suppression_id}" payload = { "note": "<string>" } headers = { "Authorization": "Bearer <token>", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.text)
const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: JSON.stringify({note: '<string>'}) }; fetch('https://api.useinvent.com/orgs/suppressions/{suppression_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://api.useinvent.com/orgs/suppressions/{suppression_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([ 'note' => '<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.useinvent.com/orgs/suppressions/{suppression_id}" payload := strings.NewReader("{\n \"note\": \"<string>\"\n}") req, _ := http.NewRequest("PATCH", 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.patch("https://api.useinvent.com/orgs/suppressions/{suppression_id}") .header("Authorization", "Bearer <token>") .header("Content-Type", "application/json") .body("{\n \"note\": \"<string>\"\n}") .asString();
require 'uri' require 'net/http' url = URI("https://api.useinvent.com/orgs/suppressions/{suppression_id}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer <token>' request["Content-Type"] = 'application/json' request.body = "{\n \"note\": \"<string>\"\n}" response = http.request(request) puts response.read_body
{ "id": "<string>", "channel": "EMAIL", "identifier": "<string>", "reason": "BOUNCE", "source": "WEBHOOK", "note": "<string>", "metadata": { "diagnostic_code": "<string>", "complaint_type": "<string>", "feedback": "<string>", "broadcast_id": "<string>", "import_batch_id": "<string>" }, "created_by": { "id": "<string>", "name": "<string>", "email": "jsmith@example.com", "avatar": "<string>", "seen_at": "2023-11-07T05:31:56Z" }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }
Bearer token authentication using your API key
Suppression ID
Schema for updating a suppression
Why the identifier is suppressed
BOUNCE
COMPLAINT
UNSUBSCRIBE
MANUAL
LEGAL
500
Schema for the suppression
The channel an identifier is suppressed on
EMAIL
PHONE
What put the identifier on the list
WEBHOOK
UNSUBSCRIBE_LINK
ADMIN
IMPORT
API
Diagnostic context kept alongside a suppression
Show child attributes
Who added the entry. Null when it landed automatically (bounce, complaint, unsubscribe link).
Was this page helpful?