Skip to content
Kirim.Email SMTP API

Reset credential password

PUT
/api/domains/{domain}/credentials/{credential}/reset-password

Reset the password for a specific SMTP credential

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.

credential
required
string format: uuid
Example
92703823-f3a4-48e2-8e87-7adf25454800

Credential GUID (user_smtp_guid)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Password reset successfully

object
success

Indicates if the request was successful

boolean
Example
true
message

Human-readable success message

string
Example
Password reset successfully.
data

Password reset result data

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
new_password

The new generated password. Store this securely as it cannot be retrieved later

string
Example
new-generated-password
strength_info

Password strength analysis and complexity information

object
remote_synced

Whether the password change 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

403

Section titled “403 ”

Forbidden - Credential does not belong to the specified domain

object
success
boolean
message
string
Example
Credential does not belong to the specified domain

404

Section titled “404 ”

Credential not found

object
success
boolean
message
string
Example
Credential not found

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.