MailConfiguration

Save the mail environment variables

post/mail/config

Request

  • Base URL: https://your-instance.example.com/api/v1
  • URL: https://your-instance.example.com/api/v1/mail/config
  • Auth: HTTP bearer

Headers

companystring required

ID of the company the request operates on (multi-tenancy).

Request body

mail_driver'sendmail' | 'smtp' | 'mail' | 'ses' | 'mailgun' | 'postmark' required
from_namestring required
from_mailstring email required
mail_sendmail_pathstring nullable

Response

success'mail_variables_save_successfully' required

Changes

No recorded changes to this operation across all 1 revision of this API.