Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| communicationTemplateId |
The communication template identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The communication template, if it exists.
Pico.CommunicationTemplate| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Gets or sets the communication template identifier. |
integer |
None. |
| bodyTemplate |
Gets or sets the body template identifier. |
integer |
None. |
| organization |
Gets or sets the organization identifier. |
integer |
None. |
| signatureTemplate |
Gets or sets the signature template identifier. |
integer |
None. |
| bcc |
Gets or sets the BCC recipient(s). |
string |
None. |
| cc |
Gets or sets the CC recipient(s). |
string |
None. |
| code |
Gets or sets the code. |
string |
None. |
| from |
Gets or sets the sender. |
string |
None. |
| fromName |
Gets or sets the sender name. |
string |
None. |
| isActive |
Gets or sets a value indicating whether the template is active. |
boolean |
None. |
| isSubscribed |
Gets or sets a value indicating whether the organization is subscribed. |
boolean |
None. |
| medium |
Gets or sets the medium. |
string |
None. |
| replyTo |
Gets or sets the "reply to" email. |
string |
None. |
| subject |
Gets or sets the subject. |
string |
None. |
| to |
Gets or sets the recipient(s). |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": "1",
"bodyTemplate": "2",
"organization": "3",
"signatureTemplate": "1",
"bcc": "sample String 4",
"cc": "sample String 5",
"code": "sample String 6",
"from": "sample String 7",
"fromName": "sample String 8",
"isActive": true,
"isSubscribed": true,
"medium": "sample String 11",
"replyTo": "sample String 12",
"subject": "sample String 13",
"to": "sample String 14"
}
text/html
Sample:
{"id":"1","bodyTemplate":"2","organization":"3","signatureTemplate":"1","bcc":"sample String 4","cc":"sample String 5","code":"sample String 6","from":"sample String 7","fromName":"sample String 8","isActive":true,"isSubscribed":true,"medium":"sample String 11","replyTo":"sample String 12","subject":"sample String 13","to":"sample String 14"}
application/xml, text/xml
Sample:
<CommunicationTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <CommunicationTemplateId>1</CommunicationTemplateId> <BodyTemplateId>2</BodyTemplateId> <OrganizationId>3</OrganizationId> <SignatureTemplateId>1</SignatureTemplateId> <Bcc>sample String 4</Bcc> <Cc>sample String 5</Cc> <Code>sample String 6</Code> <From>sample String 7</From> <FromName>sample String 8</FromName> <IsActive>true</IsActive> <IsSubscribed>true</IsSubscribed> <Medium>sample String 11</Medium> <ReplyTo>sample String 12</ReplyTo> <Subject>sample String 13</Subject> <To>sample String 14</To> </CommunicationTemplate>