Skip to content
Kirim.Email SMTP API

Create a new credential

POST
/api/domains/{domain}/credentials

Create a new SMTP credential for a domain

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 ”

SMTP credential creation details

object
username
required

SMTP username

string
Example
myuser

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Credential created successfully

object
success

Indicates if the request was successful

boolean
Example
true
message

Human-readable success message

string
Example
Credential created successfully.
data

Created credential data and metadata

object
credential

SMTP credential object containing authentication details for email sending

object
id

Database auto-increment ID (internal use only)

integer
Example
1
user_smtp_guid

Unique credential GUID used for API operations

string
Example
92703823-f3a4-48e2-8e87-7adf25454800
username

SMTP username for authentication. Must be unique within the domain

string
Example
myuser
created_at

Unix timestamp when the credential was created

integer
Example
1640995200
modified_at

Unix timestamp when the credential was last modified

integer
Example
1640995200
password

Generated password for the credential. Store this securely as it cannot be retrieved later

string
Example
generated-password
remote_synced

Whether the credential was successfully synchronized with the remote SMTP server

boolean
Example
true

401

Section titled “401 ”

Unauthorized - Invalid or missing authentication credentials

object
success
boolean
message
string
Example
Unauthorized

404

Section titled “404 ”

Credential not found

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