PUT api2/company_mail_settings/{id}.json

Update company email settings by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Company email settings ID

integer

Required

Body Parameters

company email settings

api_root
NameDescriptionTypeAdditional information
settings

CompanyEMailSettings

None.

Request Format

{
  "settings": {
    "company_id": 1,
    "dkim_Enabled": true,
    "dkim_PrivateKey": "sample string 2",
    "dkim_Domain": "sample string 3",
    "dkim_Selector": "sample string 4",
    "smtp_Enabled": true,
    "smtp_Host": "sample string 5",
    "smtp_Port": 1,
    "smtp_User": "sample string 6",
    "smtp_Password": "sample string 7",
    "valid": true
  }
}

Response Information

Resource Description

updated company email settings

api_root
NameDescriptionTypeAdditional information
settings

CompanyEMailSettings

None.

Response Format

{
  "settings": {
    "id": 1,
    "company_id": 1,
    "dkim_Enabled": true,
    "dkim_PrivateKey": "sample string 2",
    "dkim_Domain": "sample string 3",
    "dkim_Selector": "sample string 4",
    "smtp_Enabled": true,
    "smtp_Host": "sample string 5",
    "smtp_Port": 1,
    "smtp_User": "sample string 6",
    "smtp_Password": "sample string 7",
    "valid": true
  }
}