API / Paragraph

Entity Description:

Paragraph can be used to save text (e.g. a single word, a sentence, a paragraph) in an email message and can be reused in future email messages. Paragraph can save text, hyper-links, and images for future use. Paragraph is a repository for repetitive use of text, links, or images.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
ActiveState
Int16
Name
String
Description
String
OwnerID
Int32
Body
String
BodyBinary
Binary
Icon
Bitmap
LastUsed
DateTime
CreationDate
DateTime
Subject
String
Shared
Boolean
BusinessID
Int32
RegionID
Int32

Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a Paragraph

Request

POST /api/odata/Paragraphs

Content-Type 

application/json

Request body

{
"ID":"0","ActiveState":"0","Name":"New Paragraph","Description":
"Example Description","OwnerID":"0","Body":"Example Body",
"BodyBinary":"0","Icon":"Example Icon","LastUsed":"2014-11-20T01:14:23.112Z","CreationDate":"2014-10-10T12:04:02.155Z",
"Subject":"Example Subject","Shared":false,"BusinessID":"0","RegionID":"0"
}

Response body

{
"ID":1,"ActiveState":0,"Name":"New Paragraph","Description":"Example Description","OwnerID":0,"Body":"Example Body","BodyBinary":0,"Icon":"Example Icon","LastUsed":"2014-11-20T01:14:23.112Z","CreationDate":"2014-10-10T12:04:02.155Z","Subject":"Example Subject","Shared":false,"BusinessID":0,"RegionID":0
}
Deleting a Paragraph
 Request
 DELETE /api/odata/Paragraphs(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a Paragraph
 Request
 GET /api/odata/Paragraphs(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"ActiveState":0,"Name":"New Paragraph","Description":"Example Description","OwnerID":0,"Body":"Example Body","BodyBinary":0,"Icon":"Example Icon","LastUsed":"2014-11-20T01:14:23.112Z","CreationDate":"2014-10-10T12:04:02.155Z","Subject":"Example Subject","Shared":false,"BusinessID":0,"RegionID":0
}
Updating a Paragraph
 Request
 PUT /api/odata/Paragraphs(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","ActiveState":"0","Name":"New Paragraph","Description":"Example Description","OwnerID":"0","Body":"Example Body","BodyBinary":"0","Icon":"Example Icon","LastUsed":"2014-11-20T01:14:23.112Z","CreationDate":"2014-10-10T12:04:02.155Z","Subject":"Example Subject","Shared":false,"BusinessID":"0","RegionID":"0"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all Paragraphs
 Request
 GET /api/odata/Lists
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"ActiveState":0,"Name":"New Paragraph","Description":"Example Description","OwnerID":0,"Body":"Example Body","BodyBinary":0,"Icon":"Example Icon","LastUsed":"2014-11-20T01:14:23.112Z","CreationDate":"2014-10-10T12:04:02.155Z","Subject":"Example Subject","Shared":false,"BusinessID":0,"RegionID":0
},{
"ID":1,"ActiveState":0,"Name":"New Paragraph","Description":"Example Description","OwnerID":0,"Body":"Example Body","BodyBinary":0,"Icon":"Example Icon","LastUsed":"2014-11-20T01:14:23.112Z","CreationDate":"2014-10-10T12:04:02.155Z","Subject":"Example Subject","Shared":false,"BusinessID":0,"RegionID":0
}]