Request Information

URI Parameters

NameDescriptionTypeAdditional information
organizationId

The organization identifier.

 integer

None.

Body Parameters

None.

Response Information

Resource Description

A list of communication templates.

Collection of Pico.CommunicationTemplate
NameDescriptionTypeAdditional 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": "1",
    "organization": "2",
    "signatureTemplate": "1",
    "bcc": "sample String 3",
    "cc": "sample String 4",
    "code": "sample String 5",
    "from": "sample String 6",
    "fromName": "sample String 7",
    "isActive": true,
    "isSubscribed": true,
    "medium": "sample String 10",
    "replyTo": "sample String 11",
    "subject": "sample String 12",
    "to": "sample String 13"
  },
  {
    "id": "1",
    "bodyTemplate": "1",
    "organization": "2",
    "signatureTemplate": "1",
    "bcc": "sample String 3",
    "cc": "sample String 4",
    "code": "sample String 5",
    "from": "sample String 6",
    "fromName": "sample String 7",
    "isActive": true,
    "isSubscribed": true,
    "medium": "sample String 10",
    "replyTo": "sample String 11",
    "subject": "sample String 12",
    "to": "sample String 13"
  }
]

text/html

Sample: 
[{"id":"1","bodyTemplate":"1","organization":"2","signatureTemplate":"1","bcc":"sample String 3","cc":"sample String 4","code":"sample String 5","from":"sample String 6","fromName":"sample String 7","isActive":true,"isSubscribed":true,"medium":"sample String 10","replyTo":"sample String 11","subject":"sample String 12","to":"sample String 13"},{"id":"1","bodyTemplate":"1","organization":"2","signatureTemplate":"1","bcc":"sample String 3","cc":"sample String 4","code":"sample String 5","from":"sample String 6","fromName":"sample String 7","isActive":true,"isSubscribed":true,"medium":"sample String 10","replyTo":"sample String 11","subject":"sample String 12","to":"sample String 13"}]

application/xml, text/xml

Sample: 
<ArrayOfCommunicationTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CommunicationTemplate>
    <CommunicationTemplateId>1</CommunicationTemplateId>
    <BodyTemplateId>1</BodyTemplateId>
    <OrganizationId>2</OrganizationId>
    <SignatureTemplateId>1</SignatureTemplateId>
    <Bcc>sample String 3</Bcc>
    <Cc>sample String 4</Cc>
    <Code>sample String 5</Code>
    <From>sample String 6</From>
    <FromName>sample String 7</FromName>
    <IsActive>true</IsActive>
    <IsSubscribed>true</IsSubscribed>
    <Medium>sample String 10</Medium>
    <ReplyTo>sample String 11</ReplyTo>
    <Subject>sample String 12</Subject>
    <To>sample String 13</To>
  </CommunicationTemplate>
  <CommunicationTemplate>
    <CommunicationTemplateId>1</CommunicationTemplateId>
    <BodyTemplateId>1</BodyTemplateId>
    <OrganizationId>2</OrganizationId>
    <SignatureTemplateId>1</SignatureTemplateId>
    <Bcc>sample String 3</Bcc>
    <Cc>sample String 4</Cc>
    <Code>sample String 5</Code>
    <From>sample String 6</From>
    <FromName>sample String 7</FromName>
    <IsActive>true</IsActive>
    <IsSubscribed>true</IsSubscribed>
    <Medium>sample String 10</Medium>
    <ReplyTo>sample String 11</ReplyTo>
    <Subject>sample String 12</Subject>
    <To>sample String 13</To>
  </CommunicationTemplate>
</ArrayOfCommunicationTemplate>