> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.confirm.global/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.confirm.global/_mcp/server.

# Add a blocklist entry

POST https://api.confirm.global/api/v1/candidates/blocklist
Content-Type: application/json

Adds an entry to your organization's blocklist. Returns 409 if an equivalent entry already exists.


Reference: https://docs.confirm.global/api-reference/candidates/add-blocklist-entry

## Authentication

- `Authorization` header (bearer token, required) — Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

## Request

### Body (application/json)

This endpoint expects an object.

- `match_type` (enum, required)
  - Allowed values: `email`, `phone`, `name_exact`, `name_fuzzy`, `email_domain`
- `match_value` (string, required) — The value to match (email address, phone number, name, or email domain).
- `reason` (string, optional)
- `expires_at` (datetime, optional) — Optional expiry. Omit for a permanent entry.

## Response

### 201

Blocklist entry created.

- `blocklist_id` (string, optional)
- `org_id` (string, optional)
- `match_type` (enum, optional)
  - Allowed values: `email`, `phone`, `name_exact`, `name_fuzzy`, `email_domain`
- `match_value` (string, optional)
- `reason` (string, optional, nullable)
- `expires_at` (datetime, optional, nullable)
- `created_at` (datetime, optional)

## Errors

### 400 Bad Request Error

The request was invalid (missing or malformed fields, or an invalid stage transition).

- `error` (ErrorError, optional)

### 401 Unauthorized Error

Missing or invalid bearer token, or insufficient permissions.

- `error` (ErrorError, optional)

## Types

### ErrorError

- `code` (string, optional) — Machine-readable error code, e.g. VALIDATION_ERROR or CANDIDATE_NOT_FOUND.
- `message` (string, optional)
- `request_id` (string, optional) — Identifier for this request, useful when contacting support.

## Examples

**Request**

```json
{
  "match_type": "email",
  "match_value": "string"
}
```

**Response**

```json
{
  "blocklist_id": "string",
  "org_id": "string",
  "match_type": "email",
  "match_value": "string",
  "reason": "string",
  "expires_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.confirm.global/api/v1/candidates/blocklist"

payload = {
    "match_type": "email",
    "match_value": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.confirm.global/api/v1/candidates/blocklist';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"match_type":"email","match_value":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.confirm.global/api/v1/candidates/blocklist"

	payload := strings.NewReader("{\n  \"match_type\": \"email\",\n  \"match_value\": \"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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.confirm.global/api/v1/candidates/blocklist")

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  \"match_type\": \"email\",\n  \"match_value\": \"string\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.confirm.global/api/v1/candidates/blocklist")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"match_type\": \"email\",\n  \"match_value\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.confirm.global/api/v1/candidates/blocklist', [
  'body' => '{
  "match_type": "email",
  "match_value": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.confirm.global/api/v1/candidates/blocklist");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"match_type\": \"email\",\n  \"match_value\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "match_type": "email",
  "match_value": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.confirm.global/api/v1/candidates/blocklist")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```