Get Company Email Header and Footer

This operation returns the email message header and footer configured for the Company.

More Details

Path Parameters

OrganizationId string required

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

masterEmailTemplate string
companySettings object
footerTemplate string
headerTemplate string
defaultSettings object
footerTemplate string
headerTemplate string

{
  "masterEmailTemplate": "string",
  "companySettings": {
    "footerTemplate": "string",
    "headerTemplate": "string"
  },
  "defaultSettings": {
    "footerTemplate": "string",
    "headerTemplate": "string"
  }
}

{
  "masterEmailTemplate": "<!doctype html><html><head/><body><div style=\"width: 600px;padding: 0;margin: 0 auto;text-align: center;text-align:-moz-center; text-align:-webkit-center;border:0;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" bgcolor=\"#ffffff\" width=\"600\" style=\"color: #666;background: #ffffff;width: 600px;border:0;\"><tbody><tr><td width=\"100%\" valign=\"middle\" bgcolor=\"#ffffff\" style=\"color: #666666;background: #ffffff;vertical-align: middle;font-size: 1em;line-height: 1.2em; text-align: left;font-family: Helvetica, Arial, sans-serif;\">[CONTENT_EMAIL]</td></tr></tbody> </table></div></body></html>",
  "companySettings": {
    "footerTemplate": "<p>Contact your administrator at admins@mycompany.com.</p>\n",
    "headerTemplate": "<p>My Company</p>\n"
  },
  "defaultSettings": {
    "footerTemplate": "",
    "headerTemplate": ""
  }
}

GET /organization/:organizationid/emailcustomization

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

OrganizationId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Organization/:OrganizationId/EmailCustomization' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get Company Email Header and Footer​

Authorization

Request

Get Company Email Header and Footer