Skip to content
Kirim.Email SMTP API

Create whitelist suppression

POST
/api/domains/{domain}/suppressions/whitelist

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 Body required

Section titled “Request Body required ”

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

object
success
boolean
Example
true
message
string
Example
Whitelist entry created successfully.
data

Suppression entry

object
id
integer
Example
1
type
string
Allowed values: unsubscribe bounce whitelist
Example
unsubscribe
recipient_type
string
Allowed values: email domain
Example
email
recipient
string
Example
[email protected]
tags
string
nullable
Example
marketing
description
string
nullable
Example
Opted out from newsletter
source
string
nullable
Example
api
created_at
integer
Example
1711234567

401

Section titled “401 ”

Unauthorized - Invalid or missing authentication credentials

object
success
boolean
message
string
Example
Unauthorized

404

Section titled “404 ”

Not Found - Domain not found

object
success
boolean
message
string
Example
Domain not found

422

Section titled “422 ”

Validation Error - Invalid input data

object
success
boolean
message
string
Example
Validation failed.
errors

Field-specific validation errors

object

429

Section titled “429 ”

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

object
success
boolean
message
string
Example
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

object
success
boolean
message
string
Example
An error occurred while processing the request.