email-servers

Edit Email Server

put/v3.0/email-servers/{slug}/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/email-servers/{slug}/
  • Auth: none declared. Required headers: x-api-key

Path parameters

slugstring required

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Request body

sender_default_emailstring email nullable

sender's default email. if not set, email's will be sent from the system's default.

sender_default_namestring nullable

sender's default name. you'll have to set the sender default email to use this.

default_reply_to_emailstring email nullable

the default address to set as the email's default reply to email address.

smtp_usernamestring nullable

smtp username. you'll have to set this value to use the custom sender.

smtp_passwordstring required
smtp_hoststring nullable

smtp smtp host. you'll have to set this value to use the custom sender.

smtp_portinteger nullable

smtp port. you'll have to set this value to use the custom sender.

smtp_use_tlsboolean
is_enabledboolean

is this sender currently enabled?

titlestring nullable

a title to identify this email sever

Response

sender_default_emailstring email nullable

sender's default email. if not set, email's will be sent from the system's default.

sender_default_namestring nullable

sender's default name. you'll have to set the sender default email to use this.

default_reply_to_emailstring email nullable

the default address to set as the email's default reply to email address.

smtp_usernamestring nullable

smtp username. you'll have to set this value to use the custom sender.

smtp_hoststring nullable

smtp smtp host. you'll have to set this value to use the custom sender.

smtp_portinteger nullable

smtp port. you'll have to set this value to use the custom sender.

smtp_use_tlsboolean
is_enabledboolean

is this sender currently enabled?

is_activestring
slugstring nullable
titlestring nullable

a title to identify this email sever

Changes

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