Loading...

REST API - PUT Organization Email Header and Footer

This operation updates the email message header and footer configured for the organization.

Request

Syntax

PUT <webservice>/Organization/{OrganizationId}/EmailCustomization HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/json

{
  "footerTemplate":"footer text",
  "headerTemplate":"header text"
}

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

organizationId

The organization ID for the organization. If the organization ID is not known, use the GET Organization API to retrieve it. The organization ID is the ID in the shortName element.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

The following table displays the parameters for the request body.

Parameter

Description

headerTemplate

The header text for email messages. HTML markup and base64 encoded images are supported. The <img> tag must include the following information:

<img src=\"data:image/image_file_type;base64,base64_encoding"/>

Example

<img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAARCAYAAAA7bUf6AAAAAXNSR0IArs4c6QAAAARn
QU1BAACxjwv8YQUAAAAgY0hSTQAAeiYAAICEAAD6AAAAgO
gAAHUwAADqYAAAOpgAABdwnLpRPAAAAAlwSFlzAAAuIgAAL
iIBquLdkgAAAAd0SU1FB9wLExYuHwLwZI8AAAMZSURBVDhP
pZT9TwxwHMf5H8T8wESeZZKkHbq6yConQpJZo2Se5qGteUjZ
KMlduc3CPMTuRtfD8nDSwz2Xy446V1LpjiMPp9PdPMT44eW6
JvOQX3y3z/b94fN97fP+fD7v70iPx8OI/z0DkOHitfMtj191
0el4yhuna9i8EX8D1HU0kHrjHGJFOVOrogm7LCWmsI0tpxvR
Wa1/wH6B9Pa52KbNZZxqHsvri0lXPybpVi3xVeUkVJhZWHaB
sVULSdPtx+V+NwQbgri9stbrdjHRIGC+XkCi+iTZ9/rZr//A
ztsu4lSHiGyIJUgvZGxdKIm6nbg9bh9oCHLlUQVj1MHMMyxm
s0FOnuUTud7IafKQqXGRZjrKKksUkc2RzDZG4lcTQklr2U9I
n7uPkOurmFotYrXxOKc6oajjG5LWjxw3f+ZgwxMy7EmsNW4i
vDaeOdoI/DXhzLkTxzuvLF8lnTYHQYo9xKmLSDFdJL/DSWH7
F6TWfgpanEhenOBIr5jtDjGxpkTmqkUEaL2yVPN51NMxCGl6
aGOFUk9E/SE2auVsM1aQb/lI/oOv5LVqkLwXk+VcQao9hthW
EcENEQTUiBhVEoW+2zQIufewi+TSHtbcURFrzCLNrOBwk4uc
xn4yDEZ2P4knvTuate3RCO8vIdAoZOKtZYw+IMXY1jwIsTt6
WHnWSnJ1O4G6KARmARuaCsio9bBD9Zp1ZSriFBcJVycQbBIy
RRtOwIVsxqXfxGZ/MQhxu92kyeq9u9BNoCqZmd4Jhd2NJl4j
Y2O5jST5S8RnHAQr9zLFEEZA3VIm5F5jWWaF7+3QiBvNbQhP
tCAsVzBJs5jJ+lBm1SwlpqSRmDNdCAutzCjdyiSdAH9FCn4Z
EnSmtl/3ZKAimVzL7CI5/tVLmK5IRVBciUjWziJpCwvyLEw7
nYN/cRZ+W6+Tf776z431echb2qXKWqZnSpl7rJkFkk5CCiwE
5T1gxhEz4/dpGJ9Synmlxpf7w3d/NaDN/hyZoo6EbCVhe5WE
7r6G+MBVpJdrvI189m8D/u7ogab19rp8MXAf7sv4DsuZPMsm
G/YnAAAAAElFTkSuQmCC"/>

footerTemplate

The footer text for email messages. HTML markup and base64 encoded images are supported. The <img> tag must include the following information:

<img src=\"data:image/image_file_type;base64,base64_encoding"/>

Response

Response Parameters

Parameter

Description

Element

errorMessage

The description of the error code. Not all error codes have an error message.

Api_GenericResp

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

Api_GenericResp

Examples

Sample Request

PUT <webservice>/Organization/4/EmailCustomization HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json

{
  "headerTemplate": "<p><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAARCAYAAAA7bUf6AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAAAlwSFlzAAAuIgAALiIBquLdkgAAAAd0SU1FB9wLExYuHwLwZI8AAAMZSURBVDhPpZT9TwxwHMf5H8T8wESeZZKkHbq6yConQpJZo2Se5qGteUjZKMlduc3CPMTuRtfD8nDSwz2Xy446V1LpjiMPp9PdPMT44eW6JvOQX3y3z/b94fN97fP+fD7v70iPx8OI/z0DkOHitfMtj1910el4yhuna9i8EX8D1HU0kHrjHGJFOVOrogm7LCWmsI0tpxvRWa1/wH6B9Pa52KbNZZxqHsvri0lXPybpVi3xVeUkVJhZWHaBsVULSdPtx+V+NwQbgri9stbrdjHRIGC+XkCi+iTZ9/rZr//Aztsu4lSHiGyIJUgvZGxdKIm6nbg9bh9oCHLlUQVj1MHMMyxms0FOnuUTud7IafKQqXGRZjrKKksUkc2RzDZG4lcTQklr2U9In7uPkOurmFotYrXxOKc6oajjG5LWjxw3f+ZgwxMy7EmsNW4ivDaeOdoI/DXhzLkTxzuvLF8lnTYHQYo9xKmLSDFdJL/DSWH7F6TWfgpanEhenOBIr5jtDjGxpkTmqkUEaL2yVPN51NMxCGl6aGOFUk9E/SE2auVsM1aQb/lI/oOv5LVqkLwXk+VcQao9hthWEcENEQTUiBhVEoW+2zQIufewi+TSHtbcURFrzCLNrOBwk4ucxn4yDEZ2P4knvTuate3RCO8vIdAoZOKtZYw+IMXY1jwIsTt6WHnWSnJ1O4G6KARmARuaCsio9bBD9Zp1ZSriFBcJVycQbBIyRRtOwIVsxqXfxGZ/MQhxu92kyeq9u9BNoCqZmd4Jhd2NJl4jY2O5jST5S8RnHAQr9zLFEEZA3VIm5F5jWWaF7+3QiBvNbQhPtCAsVzBJs5jJ+lBm1SwlpqSRmDNdCAutzCjdyiSdAH9FCn4ZEnSmtl/3ZKAimVzL7CI5/tVLmK5IRVBciUjWziJpCwvyLEw7nYN/cRZ+W6+Tf776z431echb2qXKWqZnSpl7rJkFkk5CCiwE5T1gxhEz4/dpGJ9Synmlxpf7w3d/NaDN/hyZoo6EbCVhe5WE7r6G+MBVpJdrvI189m8D/u7ogab19rp8MXAf7sv4DsuZPMsmG/YnAAAAAElFTkSuQmCC"/></p>\n"
}

Sample Response

{
  "errorMessage": "",
  "errorCode": 0
}

Last modified: 8/17/2018 2:15:37 PM