Share Tools
Create and manage shareable content pages with optional password protection and expiration. 8 tools in this category.
share.draft
Create a draft share page.
Roles: MARKETING_AND_ADMIN | draftByDefault: true
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Share page title |
brandId | uuid | Yes | Brand identifier |
body | string | Yes | Share content (HTML or Markdown) |
hostDomain | string | No | Hosting domain (default: brand’s primary domain) |
expiresAt | datetime | No | Expiration time |
{
"tool": "share.draft",
"input": {
"title": "Q2 Campaign Results",
"brandId": "brand-uuid",
"body": "<h1>Q2 Campaign Results</h1><p>Summary of all Q2 2026 campaigns.</p>",
"expiresAt": "2026-06-30T23:59:59Z"
}
}share.publish
Publish a share page and generate the public URL.
Roles: MARKETING_AND_ADMIN
| Field | Type | Required | Description |
|---|---|---|---|
shareId | string | Yes | Share identifier |
{
"tool": "share.publish",
"input": {
"shareId": "shr_abc123"
}
}share.list
List all share pages.
Roles: ALL_ROLES
| Field | Type | Required | Description |
|---|---|---|---|
brandId | uuid | No | Filter by brand |
status | enum(draft|published|expired|archived) | No | Filter by status |
limit | integer | No | Max results (default 20) |
{
"tool": "share.list",
"input": {
"brandId": "brand-uuid",
"status": "published"
}
}share.expire
Set or update the expiration date on a share.
Roles: MARKETING_AND_ADMIN
| Field | Type | Required | Description |
|---|---|---|---|
shareId | string | Yes | Share identifier |
expiresAt | datetime | Yes | New expiration time |
{
"tool": "share.expire",
"input": {
"shareId": "shr_abc123",
"expiresAt": "2026-07-15T23:59:59Z"
}
}share.extend
Extend a share’s expiration date.
Roles: MARKETING_AND_ADMIN
| Field | Type | Required | Description |
|---|---|---|---|
shareId | string | Yes | Share identifier |
extendByDays | integer | Yes | Number of days to extend |
{
"tool": "share.extend",
"input": {
"shareId": "shr_abc123",
"extendByDays": 30
}
}share.set_password
Set or update the password on a share page.
Roles: MARKETING_AND_ADMIN
| Field | Type | Required | Description |
|---|---|---|---|
shareId | string | Yes | Share identifier |
password | string | Yes | Access password (min 8 chars) |
{
"tool": "share.set_password",
"input": {
"shareId": "shr_abc123",
"password": "SecurePass2026!"
}
}share.archive
Archive a share page. Archived shares return 410 Gone.
Roles: MARKETING_AND_ADMIN
| Field | Type | Required | Description |
|---|---|---|---|
shareId | string | Yes | Share identifier |
{
"tool": "share.archive",
"input": {
"shareId": "shr_abc123"
}
}share.list_hosts
List available share hosting domains for the brand.
Roles: ALL_ROLES
| Field | Type | Required | Description |
|---|---|---|---|
brandId | uuid | Yes | Brand identifier |
{
"tool": "share.list_hosts",
"input": {
"brandId": "brand-uuid"
}
}