Snippet

A piece of an email to be reused in multiple messages.

bodyHtml
string <= 16777215 characters

The HTML of the snippet.

bodyText
string <= 16777215 characters

The text of the snippet.

createdAt
string <date-time>

The date and time the snippet was created.

name
string <= 255 characters

The name of the snippet.

shareType
string <= 255 characters

The permissions for sharing the snippet; must be "private" or "shared."

tags
Array of strings

A list of tags associated with the snippet (e.g. ["Useful", "Prospecting"]).

updatedAt
string <date-time>

The date and time the snippet was last updated.

{
  • "bodyHtml": "string",
  • "bodyText": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "shareType": "string",
  • "tags": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Snippet Relationships

Array of data (object) or links (object) (contentCategoryMembership)

The content categories (collections) of the snippet. You can use only the attribute id to filter snippets by contentCategoryMemberships (e.g. filter[contentCategoryMemberships][id]=X).

data (object) or links (object) (user)

The creator of the snippet. You can use only the attribute id to filter snippets by creator (e.g. filter[creator][id]=X).

data (object) or links (object) (user)

The owner of the snippet. You can use only the attribute id to filter snippets by owner (e.g. filter[owner][id]=X).

data (object) or links (object) (user)

The updater of the snippet. You can use only the attribute id to filter snippets by updater (e.g. filter[updater][id]=X).

{
  • "contentCategoryMemberships": [
    ],
  • "creator": {
    },
  • "owner": {
    },
  • "updater": {
    }
}

Snippet Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Snippet Actions

Get a Collection of Snippets

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/snippets
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Snippet
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/snippets
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Snippet by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/snippets/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Snippet by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/snippets/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Snippet
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/snippets/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}