The file to upload. Must be an accepted image or PDF type. Accepted file types: image/bmp, image/jpeg, image/jpg, image/png, image/gif, application/pdf. Maximum file size: 2 MB. Maximum image dimensions: 4096px.
name
string
No
—
Custom display name for the asset. If omitted, the uploaded file’s original filename is used.
parent_folder_id
integer
null
No
—
The ID of the parent folder. Omit or set to “0” to place the asset at the root level.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file": { "type": "string", "description": "The file to upload. Must be an accepted image or PDF type. Accepted file types: `image/bmp`, `image/jpeg`, `image/jpg`, `image/png`, `image/gif`, `application/pdf`. Maximum file size: 2 MB. Maximum image dimensions: 4096px." }, "name": { "type": "string", "description": "Custom display name for the asset. If omitted, the uploaded file's original filename is used." }, "parent_folder_id": { "type": [ "integer", "null" ], "description": "The ID of the parent folder. Omit or set to \"0\" to place the asset at the root level." } }, "required": [ "PCID", "file" ]}
Display name for the folder. Must be unique among siblings in the same parent folder.
parent_folder_id
integer
null
No
—
The ID of the parent folder. Omit or set to “0” to create at the root level.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Display name for the folder. Must be unique among siblings in the same parent folder." }, "parent_folder_id": { "type": [ "integer", "null" ], "description": "The ID of the parent folder. Omit or set to \"0\" to create at the root level." } }, "required": [ "PCID", "name" ]}
Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
parent_folder_id
string
null
No
—
UUID of the parent folder. Omit or pass null to create in the root directory.
tag
string
Yes
—
The component tag name, used to reference your component in an email. Learn what characters you can use.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "HTML content" }, "name": { "type": "string", "description": "Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name." }, "parent_folder_id": { "type": [ "string", "null" ], "description": "UUID of the parent folder. Omit or pass `null` to create in the root directory." }, "tag": { "type": "string", "description": "The component tag name, used to reference your component in an email. [Learn what characters you can use](/journeys/design-studio/reusable/components/code-custom-component/#component-tag-name-validation)." } }, "required": [ "PCID", "content", "name", "tag" ]}
The name of the snippet, must be unique. Trimmed of leading and trailing whitespace before storage.
value
string
Yes
—
The contents of the snippet (plain text or Liquid). Trimmed of leading and trailing whitespace before storage. Max length is environment-specific (default 16000).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the snippet, must be unique. Trimmed of leading and trailing whitespace before storage." }, "value": { "type": "string", "description": "The contents of the snippet (plain text or Liquid). Trimmed of leading and trailing whitespace before storage. Max length is environment-specific (default 16000)." } }, "required": [ "PCID", "name", "value" ]}
A language code that indicates the language of your translated email
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID of the email." }, "language": { "type": "string", "description": "A [language code](/journeys/channels/localization/attribute/#supported-languages) that indicates the language of your translated email" } }, "required": [ "PCID", "id", "language" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "snippet_name": { "type": "string", "description": "The name of a snippet." } }, "required": [ "PCID", "snippet_name" ]}
A language code that indicates the language of your translated email
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID of the email." }, "language": { "type": "string", "description": "A [language code](/journeys/channels/localization/attribute/#supported-languages) that indicates the language of your translated email" } }, "required": [ "PCID", "id", "language" ]}
Filter results to a specific parent folder. Use 0 or omit to target the root level.
direct_descendants_only
boolean
No
—
If true, this returns only children of the parent folder.
page
integer
No
—
The page number of results you want to display. Use with limit.
limit
integer
No
—
Limit the number of results per page.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "parent_folder_id": { "type": "integer", "description": "Filter results to a specific parent folder. Use 0 or omit to target the root level." }, "direct_descendants_only": { "type": "boolean", "description": "If true, this returns only children of the parent folder." }, "page": { "type": "integer", "description": "The page number of results you want to display. Use with `limit`." }, "limit": { "type": "integer", "description": "Limit the number of results per page." } }, "required": [ "PCID" ]}
Filter results to a specific parent folder. Use 0 or omit to target the root level.
direct_descendants_only
boolean
No
—
If true, this returns only children of the parent folder.
page
integer
No
—
The page number of results you want to display. Use with limit.
limit
integer
No
—
Limit the number of results per page.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "parent_folder_id": { "type": "integer", "description": "Filter results to a specific parent folder. Use 0 or omit to target the root level." }, "direct_descendants_only": { "type": "boolean", "description": "If true, this returns only children of the parent folder." }, "page": { "type": "integer", "description": "The page number of results you want to display. Use with `limit`." }, "limit": { "type": "integer", "description": "Limit the number of results per page." } }, "required": [ "PCID" ]}
Filter by component tag name. This is the name of the tag inserted into your emails.
page
integer
No
—
The page number of results you want to display. Use with limit.
limit
integer
No
—
Limit the number of results per page.
parent_folder_id
string
No
—
Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory. To list only items in the root folder, leave parent_folder_id unset and only set direct_descendants_only to true.
direct_descendants_only
boolean
No
—
If true, this returns only children of the parent folder.
sort_by
string
No
—
Sort By
sort_order
string
No
—
Sort Order
created_before
integer
No
—
Return records created before this time. Must be a unix timestamp.
created_after
integer
No
—
Return records created after this time. Must be a unix timestamp.
updated_before
integer
No
—
Return records updated before this time. Must be a unix timestamp.
updated_after
integer
No
—
Return records updated after this time. Must be a unix timestamp.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag": { "type": "string", "description": "Filter by component tag name. This is the name of the tag inserted into your emails." }, "page": { "type": "integer", "description": "The page number of results you want to display. Use with `limit`." }, "limit": { "type": "integer", "description": "Limit the number of results per page." }, "parent_folder_id": { "type": "string", "description": "Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory. To list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`." }, "direct_descendants_only": { "type": "boolean", "description": "If true, this returns only children of the parent folder." }, "sort_by": { "type": "string", "description": "Sort By", "enum": [ "created", "updated", "name" ] }, "sort_order": { "type": "string", "description": "Sort Order", "enum": [ "asc", "desc" ] }, "created_before": { "type": "integer", "description": "Return records created before this time. Must be a unix timestamp." }, "created_after": { "type": "integer", "description": "Return records created after this time. Must be a unix timestamp." }, "updated_before": { "type": "integer", "description": "Return records updated before this time. Must be a unix timestamp." }, "updated_after": { "type": "integer", "description": "Return records updated after this time. Must be a unix timestamp." } }, "required": [ "PCID" ]}
The page number of results you want to display. Use with limit.
limit
integer
No
—
Limit the number of results per page.
parent_folder_id
string
No
—
Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory. To list only items in the root folder, leave parent_folder_id unset and only set direct_descendants_only to true.
direct_descendants_only
boolean
No
—
If true, this returns only children of the parent folder.
sort_by
string
No
—
Sort By
sort_order
string
No
—
Sort Order
created_before
integer
No
—
Return records created before this time. Must be a unix timestamp.
created_after
integer
No
—
Return records created after this time. Must be a unix timestamp.
updated_before
integer
No
—
Return records updated before this time. Must be a unix timestamp.
updated_after
integer
No
—
Return records updated after this time. Must be a unix timestamp.
is_template
string
No
—
Filter by whether the email is a template
has_translations
string
No
—
Filter by whether the email has translations
is_linked
string
No
—
Filter by whether the email is linked to a workflow (campaign, broadcast, etc).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number of results you want to display. Use with `limit`." }, "limit": { "type": "integer", "description": "Limit the number of results per page." }, "parent_folder_id": { "type": "string", "description": "Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory. To list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`." }, "direct_descendants_only": { "type": "boolean", "description": "If true, this returns only children of the parent folder." }, "sort_by": { "type": "string", "description": "Sort By", "enum": [ "created", "updated", "name" ] }, "sort_order": { "type": "string", "description": "Sort Order", "enum": [ "asc", "desc" ] }, "created_before": { "type": "integer", "description": "Return records created before this time. Must be a unix timestamp." }, "created_after": { "type": "integer", "description": "Return records created after this time. Must be a unix timestamp." }, "updated_before": { "type": "integer", "description": "Return records updated before this time. Must be a unix timestamp." }, "updated_after": { "type": "integer", "description": "Return records updated after this time. Must be a unix timestamp." }, "is_template": { "type": "string", "description": "Filter by whether the email is a template", "enum": [ "true", "false", "any" ] }, "has_translations": { "type": "string", "description": "Filter by whether the email has translations", "enum": [ "true", "false", "any" ] }, "is_linked": { "type": "string", "description": "Filter by whether the email is linked to a workflow (campaign, broadcast, etc).", "enum": [ "true", "false", "any" ] } }, "required": [ "PCID" ]}
The page number of results you want to display. Use with limit.
limit
integer
No
—
Limit the number of results per page.
parent_folder_id
string
No
—
Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory. To list only items in the root folder, leave parent_folder_id unset and only set direct_descendants_only to true.
direct_descendants_only
boolean
No
—
If true, this returns only children of the parent folder.
sort_by
string
No
—
Sort By
sort_order
string
No
—
Sort Order
created_before
integer
No
—
Return records created before this time. Must be a unix timestamp.
created_after
integer
No
—
Return records created after this time. Must be a unix timestamp.
updated_before
integer
No
—
Return records updated before this time. Must be a unix timestamp.
updated_after
integer
No
—
Return records updated after this time. Must be a unix timestamp.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number of results you want to display. Use with `limit`." }, "limit": { "type": "integer", "description": "Limit the number of results per page." }, "parent_folder_id": { "type": "string", "description": "Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory. To list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`." }, "direct_descendants_only": { "type": "boolean", "description": "If true, this returns only children of the parent folder." }, "sort_by": { "type": "string", "description": "Sort By", "enum": [ "created", "updated", "name" ] }, "sort_order": { "type": "string", "description": "Sort Order", "enum": [ "asc", "desc" ] }, "created_before": { "type": "integer", "description": "Return records created before this time. Must be a unix timestamp." }, "created_after": { "type": "integer", "description": "Return records created after this time. Must be a unix timestamp." }, "updated_before": { "type": "integer", "description": "Return records updated before this time. Must be a unix timestamp." }, "updated_after": { "type": "integer", "description": "Return records updated after this time. Must be a unix timestamp." } }, "required": [ "PCID" ]}
New display name for the asset. Cannot be blank after trimming.
parent_folder_id
integer
null
No
—
The ID of the new parent folder. Set to null to move the asset to the root level.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the resource." }, "name": { "type": "string", "description": "New display name for the asset. Cannot be blank after trimming." }, "parent_folder_id": { "type": [ "integer", "null" ], "description": "The ID of the new parent folder. Set to `null` to move the asset to the root level." } }, "required": [ "PCID", "id" ]}
New display name for the folder. Cannot be blank after trimming.
parent_folder_id
integer
null
No
—
The ID of the new parent folder. Set to null to move the folder to the root level. Cannot be the folder itself or one of its descendants.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the resource." }, "name": { "type": "string", "description": "New display name for the folder. Cannot be blank after trimming." }, "parent_folder_id": { "type": [ "integer", "null" ], "description": "The ID of the new parent folder. Set to `null` to move the folder to the root level. Cannot be the folder itself or one of its descendants." } }, "required": [ "PCID", "id" ]}
Your request is a free form object representing the contents of your collection. This request replaces the contents of the collection entirely, so include all contents that you want to remain in the collection—whether they change or not.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collection_id": { "type": "integer", "description": "The identifier for a collection." }, "body": { "type": "object", "description": "Your request is a free form object representing the contents of your collection. This request replaces the contents of the collection entirely, so include all contents that you want to remain in the collection—whether they change or not." } }, "required": [ "PCID", "collection_id" ]}
Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.
parent_folder_id
string
null
No
—
The UUID of the parent folder. Omit if you want no change to where the folder or file is located. Include null to move it to your root directory. Or add the UUID of another folder to move it there.
tag
string
No
—
The component tag name, used to reference your component in an email. Learn what characters you can use.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID of the component." }, "content": { "type": "string", "description": "HTML content" }, "name": { "type": "string", "description": "Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name." }, "parent_folder_id": { "type": [ "string", "null" ], "description": "The UUID of the parent folder. Omit if you want no change to where the folder or file is located. Include `null` to move it to your root directory. Or add the UUID of another folder to move it there." }, "tag": { "type": "string", "description": "The component tag name, used to reference your component in an email. Learn what [characters](/journeys/design-studio/reusable/components/code-custom-component/#component-tag-name-validation) you can use." } }, "required": [ "PCID", "id" ]}
The envelope of your email, like from and to addresses.
is_template
boolean
No
—
Whether the email is a reusable template.
name
string
No
—
Display name of the email.
parent_folder_id
string
null
No
—
The UUID of the parent folder. Omit if you want no change to where the folder or file is located. Include null to move it to your root directory. Or add the UUID of another folder to move it there.
transformers
object
No
—
Automate repetitive actions like removing white space and inlining CSS with transformers.
Name of the folder. Cannot contain any of these characters: < > : ” / \ | ? * .
parent_folder_id
string
null
No
—
The UUID of the parent folder. Omit if you want no change to where the folder or file is located. Include null to move it to your root directory. Or add the UUID of another folder to move it there.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID of the folder." }, "name": { "type": "string", "description": "Name of the folder. Cannot contain any of these characters: < > : \" / \\ | ? * ." }, "parent_folder_id": { "type": [ "string", "null" ], "description": "The UUID of the parent folder. Omit if you want no change to where the folder or file is located. Include `null` to move it to your root directory. Or add the UUID of another folder to move it there." } }, "required": [ "PCID", "id" ]}
The name of the snippet, must be unique. Trimmed of leading and trailing whitespace before storage.
value
string
No
—
The contents of the snippet (plain text or Liquid). Trimmed of leading and trailing whitespace before storage. Max length is environment-specific (default 16000).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the snippet, must be unique. Trimmed of leading and trailing whitespace before storage." }, "value": { "type": "string", "description": "The contents of the snippet (plain text or Liquid). Trimmed of leading and trailing whitespace before storage. Max length is environment-specific (default 16000)." } }, "required": [ "PCID" ]}