Home
API Reference
Support homeSupport requestsSystem statusTrust centerTry for free
Start typing to search…

Update email configuration

post
https://{tenant}/admin/api/v1/instance/email

You can update the email configuration by calling this endpoint. If set to enabled, a username, a server and a connection type should be present in the request.

REQUIRED API PERMISSION
write:config_instance
Body Params
string | null
enum

Should not be null when enabled.

Allowed:
string
length between 3 and 512

Override sender email domain with a custom value

boolean
Defaults to false

When disabled and both username and password fields are null then both get cleared.

string
length between 1 and 255

If password field was previously set then it will not be overridden unless provided.

int32
0 to 65535
Defaults to 0
string
length between 1 and 255

Should not be null when enabled.

string
length between 1 and 255

Should not be null when enabled.

Headers
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/problem+json
Updated about 1 month ago