Skip to content
Kirim.Email SMTP API

Create whitelist suppression

POST
/api/domains/{domain}/suppressions/whitelist
curl --request POST \
  --url https://smtp-app.kirim.email/api/domains/example.com/suppressions/whitelist \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "recipient": "[email protected]", "recipient_type": "email", "description": "Trusted sender" }'

Add a new entry to whitelist suppressions

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
domain
required
string
Example
example.com

Domain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.

Request Bodyrequired

Section titled “Request Bodyrequired”

Whitelist suppression entry details

object
recipient
required

Email or domain to whitelist

string
Example
[email protected]
recipient_type
required

Type of recipient

string
Allowed values: email domain
Example
email
description

Optional description

string
Example
Trusted sender

Responses

Section titled “Responses”

201

Section titled “201”

Whitelist entry created successfully

Media typeapplication/json
object
success
boolean
message
string
data

Suppression entry

object
id
integer
type
string
Allowed values: unsubscribe bounce whitelist
recipient_type
string
Allowed values: email domain
recipient
string
tags
string
nullable
description
string
nullable
source
string
nullable
created_at
integer
Example
{
  "success": true,
  "message": "Whitelist entry created successfully.",
  "data": {
    "id": 1,
    "type": "unsubscribe",
    "recipient_type": "email",
    "recipient": "[email protected]",
    "tags": "marketing",
    "description": "Opted out from newsletter",
    "source": "api",
    "created_at": 1711234567
  }
}

401

Section titled “401”

Unauthorized - Invalid or missing authentication credentials

Media typeapplication/json
object
success
boolean
message
string
Example
{
  "success": false,
  "message": "Unauthorized"
}

404

Section titled “404”

Not Found - Domain not found

Media typeapplication/json
object
success
boolean
message
string
Example
{
  "success": false,
  "message": "Domain not found"
}

422

Section titled “422”

Validation Error - Invalid input data

Media typeapplication/json
object
success
boolean
message
string
errors

Field-specific validation errors

object
Example
{
  "success": false,
  "message": "Validation failed."
}

429

Section titled “429”

Too Many Requests - Rate limit exceeded. Retry after the specified time.

Media typeapplication/json
object
success
boolean
message
string
Example
{
  "success": false,
  "message": "Too many attempts. Please try again later."
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Maximum requests per minute

X-RateLimit-Remaining
integer

Remaining requests in current window

500

Section titled “500”

Server Error - Unexpected error occurred

Media typeapplication/json
object
success
boolean
message
string
Example
{
  "success": false,
  "message": "An error occurred while processing the request."
}