---
canonical_url: "https://docs.composio.dev/toolkits/timetopost"
markdown_url: "https://docs.composio.dev/toolkits/timetopost.md"
product: "platform"
version: null
last_updated: null
---

# TimeToPost

TimeToPost helps teams create, schedule, publish, and analyze social media content across connected accounts.

- **Category:** social media marketing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 92
- **Triggers:** 0
- **Slug:** `TIMETOPOST`
- **Version:** 00000000_00

## Tools

### Record metrics for a post

**Slug:** `TIMETOPOST_CREATE_ANALYTICS_METRICS`

Record metrics for a post (usually called after fetching from platform API)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `likes` | number | No | Likes to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `reach` | number | No | Reach to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `saves` | number | No | Saves to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `views` | number | No | Views to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `clicks` | number | No | Clicks to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `shares` | number | No | Shares to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `post_id` | string | Yes | Post id to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `comments` | number | No | Comments to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `platform` | string | Yes | Platform to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `impressions` | number | No | Impressions to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `published_at` | string | No | Published at to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `integration_id` | string | No | Integration id to use when requesting: Record metrics for a post (usually called after fetching from platform API). |
| `platform_post_id` | string | No | Platform post id to use when requesting: Record metrics for a post (usually called after fetching from platform API). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a backlink opportunity

**Slug:** `TIMETOPOST_CREATE_BACKLINKS`

Create a backlink opportunity Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Url to use when requesting: Create a backlink opportunity. |
| `niche` | string | No | Niche to use when requesting: Create a backlink opportunity. |
| `notes` | string | No | Notes to use when requesting: Create a backlink opportunity. |
| `domain` | string | Yes | Domain to use when requesting: Create a backlink opportunity. |
| `keywords` | array | No | Keywords to use when requesting: Create a backlink opportunity. |
| `priority` | string | No | Priority to use when requesting: Create a backlink opportunity. |
| `page_type` | string | No | Page type to use when requesting: Create a backlink opportunity. |
| `page_title` | string | No | Page title to use when requesting: Create a backlink opportunity. |
| `spam_score` | integer | No | Spam score to use when requesting: Create a backlink opportunity. |
| `page_authority` | integer | No | Page authority to use when requesting: Create a backlink opportunity. |
| `relevance_score` | integer | No | Relevance score to use when requesting: Create a backlink opportunity. |
| `domain_authority` | integer | No | Domain authority to use when requesting: Create a backlink opportunity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk import backlink opportunities

**Slug:** `TIMETOPOST_CREATE_BACKLINKS_BULK`

Bulk import backlink opportunities Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunities` | array | No | Backlink opportunity objects to import. The bulk endpoint does not require item fields; optional known fields mirror the single-create schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new company profile

**Slug:** `TIMETOPOST_CREATE_COMPANY_PROFILES`

Create a new company profile Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string | No | Logo to use when requesting: Create a new company profile. |
| `name` | string | Yes | Name to use when requesting: Create a new company profile. |
| `website` | string | No | Website to use when requesting: Create a new company profile. |
| `industry` | string | No | Industry to use when requesting: Create a new company profile. |
| `description` | string | No | Description to use when requesting: Create a new company profile. |
| `target_audience` | string | No | Target audience to use when requesting: Create a new company profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create-or-update the org's canonical company profile

**Slug:** `TIMETOPOST_CREATE_COMPANY_PROFILES_PRIMARY`

Create-or-update the org's canonical company profile

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string | No | Logo to use when requesting: Create-or-update the org's canonical company profile. |
| `name` | string | No | Name to use when requesting: Create-or-update the org's canonical company profile. |
| `website` | string | No | Website to use when requesting: Create-or-update the org's canonical company profile. |
| `industry` | string | No | Industry to use when requesting: Create-or-update the org's canonical company profile. |
| `description` | string | No | Description to use when requesting: Create-or-update the org's canonical company profile. |
| `target_audience` | string | No | Target audience to use when requesting: Create-or-update the org's canonical company profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new content batch

**Slug:** `TIMETOPOST_CREATE_CONTENT_BATCHES`

Create a new content batch Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name to use when requesting: Create a new content batch. |
| `description` | string | No | Description to use when requesting: Create a new content batch. |
| `company_profile_id` | string | Yes | Company profile id to use when requesting: Create a new content batch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an email template

**Slug:** `TIMETOPOST_CREATE_EMAIL_TEMPLATES`

Create an email template Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body to use when requesting: Create an email template. |
| `name` | string | Yes | Name to use when requesting: Create an email template. |
| `type` | string ("INITIAL" | "FOLLOW_UP_1" | "FOLLOW_UP_2" | "FOLLOW_UP_3" | "THANK_YOU" | "CUSTOM") | No | Type to use when requesting: Create an email template. Allowed values: INITIAL, FOLLOW_UP_1, FOLLOW_UP_2, FOLLOW_UP_3, THANK_YOU, CUSTOM. |
| `subject` | string | Yes | Subject to use when requesting: Create an email template. |
| `category` | string | No | Category to use when requesting: Create an email template. |
| `is_default` | boolean | No | Is default to use when requesting: Create an email template. |
| `description` | string | No | Description to use when requesting: Create an email template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate a template

**Slug:** `TIMETOPOST_CREATE_EMAIL_TEMPLATES_ID_DUPLICATE`

Duplicate a template Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the duplicate used to duplicate a template. Obtain it from the corresponding list or get action. |
| `name` | string | No | Name to use when requesting: Duplicate a template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview a template with variables filled in

**Slug:** `TIMETOPOST_CREATE_EMAIL_TEMPLATES_ID_PREVIEW`

Preview a template with variables filled in Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the preview used to preview a template with variables filled in. Obtain it from the corresponding list or get action. |
| `variables` | object | No | Variables to use when requesting: Preview a template with variables filled in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start a page generation job

**Slug:** `TIMETOPOST_CREATE_GENERATION_JOBS`

Start a page generation job Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Batch id to use when requesting: Start a page generation job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate a single item of a batch

**Slug:** `TIMETOPOST_CREATE_GENERATION_JOBS_BATCHID_ITEMS_SLUG`

Generate a single item of a batch (RESTful) and persist it This persisted variant saves the generated item in the batch; use the generate-item action for a non-persisting result. Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slug` | string | Yes | Slug identifying the item used to generate a single item of a batch (RESTful) and persist it. |
| `batch_id` | string | Yes | ID of the item used to generate a single item of a batch (RESTful) and persist it. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate a single item from a batch

**Slug:** `TIMETOPOST_CREATE_GENERATION_JOBS_GENERATE_ITEM`

Generate a single item from a batch This non-persisting variant returns the generated item without saving it; use the RESTful batch-item action when the result must be persisted. Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Batch id to use when requesting: Generate a single item from a batch. |
| `item_slug` | string | Yes | Item slug to use when requesting: Generate a single item from a batch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new collection

**Slug:** `TIMETOPOST_CREATE_INTEGRATIONS_CREATE_COLLECTION`

Create a new collection (empty group that can have accounts added later)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_name` | string | Yes | Name of the collection to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify an integration's stored access token by calling the platform's profile endpoint

**Slug:** `TIMETOPOST_CREATE_INTEGRATIONS_ID_TEST_CONNECTION`

Verify an integration's stored access token by calling the platform's profile endpoint Admin/owner-only test endpoint. Confirms that the access token stored on the integration is still valid by hitting the platform's profile API. Distinguishes auth failures (returns 200 with `ok:false`) from infra failures (returns 500).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the test connection used to verify an integration's stored access token by calling the platform's profile endpoint. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move an account to a different group or ungroup it

**Slug:** `TIMETOPOST_CREATE_INTEGRATIONS_MOVE_ACCOUNT`

Move an account to a different group or ungroup it Invocation requirement: provide all of accountId.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | No | Account id to use when requesting: Move an account to a different group or ungroup it. This field is required for this action. |
| `group_name` | string | No | Group name to use when requesting: Move an account to a different group or ungroup it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move several accounts into one collection

**Slug:** `TIMETOPOST_CREATE_INTEGRATIONS_MOVE_ACCOUNTS`

Move several accounts into one collection (or out of every collection)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_ids` | array | Yes | Account ids to use when requesting: Move several accounts into one collection (or out of every collection). |
| `collection_id` | string | No | Collection id to use when requesting: Move several accounts into one collection (or out of every collection). |
| `collection_name` | string | No | Collection name to use when requesting: Move several accounts into one collection (or out of every collection). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename a group by updating all accounts with the old group name

**Slug:** `TIMETOPOST_CREATE_INTEGRATIONS_RENAME_GROUP`

Rename a group by updating all accounts with the old group name Invocation requirement: provide all of oldGroupName, newGroupName.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `new_group_name` | string | No | New group name to use when requesting: Rename a group by updating all accounts with the old group name. This field is required for this action. |
| `old_group_name` | string | No | Old group name to use when requesting: Rename a group by updating all accounts with the old group name. This field is required for this action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update account details

**Slug:** `TIMETOPOST_CREATE_INTEGRATIONS_UPDATE_ACCOUNT`

Update account details (displayName, groupName) for the most recently connected account Invocation requirement: provide all of provider. Invocation requirement: provide at least one of displayName, groupName.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | No | Provider to use when requesting: Update account details (displayName, groupName) for the most recently connected account. This field is required for this action. |
| `group_name` | string | No | Group name to use when requesting: Update account details (displayName, groupName) for the most recently connected account. Provide at least one of: displayName, groupName. |
| `display_name` | string | No | Display name to use when requesting: Update account details (displayName, groupName) for the most recently connected account. Provide at least one of: displayName, groupName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new short link

**Slug:** `TIMETOPOST_CREATE_LINKS`

Create a new short link Requires TimeToPost STARTER or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand` | string | No | Brand or niche slug for resolving its UTM policy and default campaign name. |
| `title` | string | No | Title to use when requesting: Create a new short link. |
| `post_id` | string | No | Post id to use when requesting: Create a new short link. |
| `platform` | string | No | Platform to use when requesting: Create a new short link. |
| `utm_term` | string | No | Utm term to use when requesting: Create a new short link. |
| `expires_at` | string | No | Expires at to use when requesting: Create a new short link. |
| `utm_medium` | string | No | Utm medium to use when requesting: Create a new short link. |
| `utm_source` | string | No | Utm source to use when requesting: Create a new short link. |
| `utm_content` | string | No | Utm content to use when requesting: Create a new short link. |
| `original_url` | string | Yes | Original url to use when requesting: Create a new short link. |
| `utm_campaign` | string | No | Utm campaign to use when requesting: Create a new short link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create short links for multiple platforms

**Slug:** `TIMETOPOST_CREATE_LINKS_BULK`

Create short links for multiple platforms (for a post) Requires TimeToPost STARTER or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand` | string | No | Brand or niche slug for resolving its UTM policy and default campaign name. |
| `post_id` | string | Yes | Post id to use when requesting: Create short links for multiple platforms (for a post). |
| `platforms` | array | Yes | Platforms to use when requesting: Create short links for multiple platforms (for a post). |
| `original_url` | string | Yes | Original url to use when requesting: Create short links for multiple platforms (for a post). |
| `utm_campaign` | string | No | Utm campaign to use when requesting: Create short links for multiple platforms (for a post). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Media Upload URL

**Slug:** `TIMETOPOST_CREATE_MEDIA_UPLOAD_URL`

Create a short-lived presigned URL for supported image or video media. This action only creates the URL; it does not upload media bytes. Upload the file separately, then use public_url when attaching the media to a post.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | Original media filename including its extension. |
| `size_bytes` | integer | Yes | Exact media file size in bytes. |
| `content_type` | string | Yes | Media MIME type. Supported families include JPEG, PNG, GIF, WebP, MP4, MOV, and AVI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a campaign

**Slug:** `TIMETOPOST_CREATE_OUTREACH_CAMPAIGNS`

Create a campaign Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal` | string | No | Goal to use when requesting: Create a campaign. |
| `name` | string | Yes | Name to use when requesting: Create a campaign. |
| `end_date` | string | No | End date to use when requesting: Create a campaign. |
| `start_date` | string | No | Start date to use when requesting: Create a campaign. |
| `description` | string | No | Description to use when requesting: Create a campaign. |
| `max_follow_ups` | integer | No | Max follow ups to use when requesting: Create a campaign. |
| `daily_send_limit` | integer | No | Daily send limit to use when requesting: Create a campaign. |
| `follow_up_enabled` | boolean | No | Follow up enabled to use when requesting: Create a campaign. |
| `follow_up_delay_days` | integer | No | Follow up delay days to use when requesting: Create a campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new contact

**Slug:** `TIMETOPOST_CREATE_OUTREACH_CONTACTS`

Create a new contact Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags to use when requesting: Create a new contact. |
| `email` | string | Yes | Email to use when requesting: Create a new contact. |
| `notes` | string | No | Notes to use when requesting: Create a new contact. |
| `phone` | string | No | Phone to use when requesting: Create a new contact. |
| `source` | string | No | Source to use when requesting: Create a new contact. |
| `company` | string | No | Company to use when requesting: Create a new contact. |
| `website` | string | No | Website to use when requesting: Create a new contact. |
| `job_title` | string | No | Job title to use when requesting: Create a new contact. |
| `last_name` | string | No | Last name to use when requesting: Create a new contact. |
| `first_name` | string | No | First name to use when requesting: Create a new contact. |
| `twitter_url` | string | No | Twitter url to use when requesting: Create a new contact. |
| `linkedin_url` | string | No | Linkedin url to use when requesting: Create a new contact. |
| `backlink_opportunity_id` | string | No | Backlink opportunity id to use when requesting: Create a new contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk import contacts

**Slug:** `TIMETOPOST_CREATE_OUTREACH_CONTACTS_BULK`

Bulk import contacts Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | No | Outreach contact objects to import. The bulk endpoint does not require item fields; optional known fields mirror the single-create schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement metrics aggregated by day of week

**Slug:** `TIMETOPOST_GET_ANALYTICS_METRICS_BY_DAY`

Get engagement metrics aggregated by day of week

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("instagram" | "twitter" | "youtube" | "linkedin" | "tiktok" | "facebook") | No | Filter by specific platform Allowed values: instagram, twitter, youtube, linkedin, tiktok, facebook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement metrics aggregated by hour of day

**Slug:** `TIMETOPOST_GET_ANALYTICS_METRICS_BY_HOUR`

Get engagement metrics aggregated by hour of day

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("instagram" | "twitter" | "youtube" | "linkedin" | "tiktok" | "facebook") | No | Filter by specific platform Allowed values: instagram, twitter, youtube, linkedin, tiktok, facebook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metrics for a specific post

**Slug:** `TIMETOPOST_GET_ANALYTICS_METRICS_POSTID`

Get metrics for a specific post

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the next recommended posting time

**Slug:** `TIMETOPOST_GET_ANALYTICS_NEXT_OPTIMAL_TIME`

Get the next recommended posting time Requires TimeToPost STARTER or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("instagram" | "twitter" | "youtube" | "linkedin" | "tiktok" | "facebook") | No | Filter by specific platform Allowed values: instagram, twitter, youtube, linkedin, tiktok, facebook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get optimal posting times for each connected account

**Slug:** `TIMETOPOST_GET_ANALYTICS_OPTIMAL_TIMES_BY_ACCOUNT`

Get optimal posting times for each connected account Requires TimeToPost STARTER or higher.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Public, anonymized hourly engagement curve for a platform

**Slug:** `TIMETOPOST_GET_ANALYTICS_PUBLIC_BEST_TIMES`

Public, anonymized hourly engagement curve for a platform (TIM-56) No auth. Returns a relative 0-100 engagement score per UTC hour, aggregated across all orgs' post metrics (counts only — no user data). Slices with too few datapoints fall back to editorial defaults, labeled source: 'editorial'. Backs the /best-time-to-post pSEO pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dow` | integer | No | Day of week (0 = Sunday ... 6 = Saturday). Omit for all days. |
| `platform` | string ("instagram" | "tiktok" | "twitter" | "linkedin" | "pinterest" | "youtube" | "facebook") | Yes | Platform value used to public, anonymized hourly engagement curve for a platform (TIM-56) via GET /api/analytics/public/best-times. Allowed values: instagram, tiktok, twitter, linkedin, pinterest, youtube, facebook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Public, anonymized dataset stats for best-time aggregates

**Slug:** `TIMETOPOST_GET_ANALYTICS_PUBLIC_BEST_TIMES_STATS`

Public, anonymized dataset stats for best-time aggregates No auth. Returns counts and provenance flags for the public best-time dataset. Counts are aggregate only; no per-account, per-post, or absolute engagement metrics are exposed.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Analytics Sync Health

**Slug:** `TIMETOPOST_GET_ANALYTICS_SYNC_HEALTH`

Get the latest metrics-sync status, errors, and counts for connected accounts. Available on the TimeToPost FREE tier.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate a suggested posting schedule for the next week

**Slug:** `TIMETOPOST_GET_ANALYTICS_WEEKLY_SCHEDULE`

Generate a suggested posting schedule for the next week Requires TimeToPost STARTER or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("instagram" | "twitter" | "youtube" | "linkedin" | "tiktok" | "facebook") | No | Filter by specific platform Allowed values: instagram, twitter, youtube, linkedin, tiktok, facebook. |
| `posts_per_week` | integer | No | Number of posts to schedule per week |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all backlink opportunities

**Slug:** `TIMETOPOST_GET_BACKLINKS`

Get all backlink opportunities Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page value used to get all backlink opportunities via GET /api/backlinks. |
| `limit` | integer | No | Limit value used to get all backlink opportunities via GET /api/backlinks. |
| `niche` | string | No | Niche value used to get all backlink opportunities via GET /api/backlinks. |
| `min_da` | integer | No | Min da value used to get all backlink opportunities via GET /api/backlinks. |
| `status` | string ("DISCOVERED" | "REVIEWING" | "APPROVED" | "CONTACTED" | "IN_PROGRESS" | "ACQUIRED" | "REJECTED" | "LOST") | No | Status value used to get all backlink opportunities via GET /api/backlinks. Allowed values: DISCOVERED, REVIEWING, APPROVED, CONTACTED, IN_PROGRESS, ACQUIRED, REJECTED, LOST. |
| `priority` | string ("LOW" | "MEDIUM" | "HIGH" | "CRITICAL") | No | Priority value used to get all backlink opportunities via GET /api/backlinks. Allowed values: LOW, MEDIUM, HIGH, CRITICAL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a backlink opportunity by ID

**Slug:** `TIMETOPOST_GET_BACKLINKS_ID`

Get a backlink opportunity by ID Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the backlink used to get a backlink opportunity by ID. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get backlink statistics

**Slug:** `TIMETOPOST_GET_BACKLINKS_STATS`

Get backlink statistics Requires TimeToPost PRO.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all company profiles for current user

**Slug:** `TIMETOPOST_GET_COMPANY_PROFILES`

Get all company profiles for current user Requires an active TimeToPost subscription.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a specific company profile

**Slug:** `TIMETOPOST_GET_COMPANY_PROFILES_ID`

Get a specific company profile Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the company profile used to get a specific company profile. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the org's canonical company profile

**Slug:** `TIMETOPOST_GET_COMPANY_PROFILES_PRIMARY`

Get the org's canonical company profile (mega-audit §3, TIM-109) Backs both /api/auth/me/company and the Integrations "Company Setup" tab. Returns the same DTO shape as /me/company so both callers can share a form. Registered before /:id so "primary" is never matched as a profile id. Deliberately NOT gated by requireActiveSubscription (unlike the rest of this router) — /me/company never was, and this consolidation must not newly wall off "Company Setup" from users filling it in pre-subscription during onboarding.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all content batches for a company profile

**Slug:** `TIMETOPOST_GET_CONTENT_BATCHES`

Get all content batches for a company profile Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_profile_id` | string | Yes | Company profile id value used to get all content batches for a company profile via GET /api/content-batches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a specific content batch

**Slug:** `TIMETOPOST_GET_CONTENT_BATCHES_ID`

Get a specific content batch Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the content batche used to get a specific content batch. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export generated pages as MDX files

**Slug:** `TIMETOPOST_GET_CONTENT_BATCHES_ID_EXPORT`

Export generated pages as MDX files Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the content batche used to export generated pages as MDX files. Obtain it from the corresponding list or get action. |
| `format` | string ("zip" | "json") | No | Format value used to export generated pages as MDX files via GET /api/content-batches/{id}/export. Allowed values: zip, json. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all email templates

**Slug:** `TIMETOPOST_GET_EMAIL_TEMPLATES`

Get all email templates Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("INITIAL" | "FOLLOW_UP_1" | "FOLLOW_UP_2" | "FOLLOW_UP_3" | "THANK_YOU" | "CUSTOM") | No | Type value used to get all email templates via GET /api/email-templates. Allowed values: INITIAL, FOLLOW_UP_1, FOLLOW_UP_2, FOLLOW_UP_3, THANK_YOU, CUSTOM. |
| `active` | boolean | No | Active value used to get all email templates via GET /api/email-templates. |
| `category` | string | No | Category value used to get all email templates via GET /api/email-templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an email template by ID

**Slug:** `TIMETOPOST_GET_EMAIL_TEMPLATES_ID`

Get an email template by ID Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the email template used to get an email template by ID. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Summary

**Slug:** `TIMETOPOST_GET_ENGAGEMENT_SUMMARY`

Get organization-wide post and engagement totals available on the FREE tier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("instagram" | "twitter" | "youtube" | "linkedin" | "tiktok" | "facebook") | No | Filter the engagement summary by a specific platform. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get generation job status

**Slug:** `TIMETOPOST_GET_GENERATION_JOBS_BATCHID_STATUS`

Get generation job status Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | ID of the generation job used to get generation job status. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all collections for the authenticated user

**Slug:** `TIMETOPOST_GET_INTEGRATIONS_COLLECTIONS`

Get all collections for the authenticated user

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List the org's connected Pinterest account's boards

**Slug:** `TIMETOPOST_GET_INTEGRATIONS_PINTEREST_BOARDS`

List the org's connected Pinterest account's boards Used by schedule_post callers to resolve a boardId before publishing — Pinterest requires platformData.pinterest.boardId on every pin.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get media from a connected integration

**Slug:** `TIMETOPOST_GET_INTEGRATIONS_PROVIDER_MEDIA`

Get media from a connected integration

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Limit value used to get media from a connected integration via GET /api/integrations/{provider}/media. |
| `provider` | string | Yes | Provider identifying the media used to get media from a connected integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get profile information for a connected integration

**Slug:** `TIMETOPOST_GET_INTEGRATIONS_PROVIDER_PROFILE`

Get profile information for a connected integration

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | Yes | Provider identifying the profile used to get profile information for a connected integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Current TikTok posting settings for a connected account

**Slug:** `TIMETOPOST_GET_INTEGRATIONS_TIKTOK_CREATOR_INFO`

Current TikTok posting settings for a connected account Proxies TikTok's /v2/post/publish/creator_info/query/ so the composer can render a compliant Direct Post form: who the post goes out as, which privacy levels the creator may choose, which interactions their account has switched off, and the maximum video length they may upload. TikTok requires this call before every Direct Post, and its response must not be cached across sessions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | No | Integration id of the TikTok account. Defaults to the org's first connected TikTok account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all short links for the authenticated user

**Slug:** `TIMETOPOST_GET_LINKS`

Get all short links for the authenticated user

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Number of links to return (default 50) |
| `offset` | number | No | Offset for pagination |
| `post_id` | string | No | Filter by post ID |
| `platform` | string | No | Filter by platform |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get aggregated analytics for all user's links

**Slug:** `TIMETOPOST_GET_LINKS_ANALYTICS`

Get aggregated analytics for all user's links

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | End date value used to get aggregated analytics for all user's links via GET /api/links/analytics. |
| `start_date` | string | No | Start date value used to get aggregated analytics for all user's links via GET /api/links/analytics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a specific short link

**Slug:** `TIMETOPOST_GET_LINKS_ID`

Get a specific short link

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the link used to get a specific short link. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get analytics for a specific short link

**Slug:** `TIMETOPOST_GET_LINKS_ID_ANALYTICS`

Get analytics for a specific short link

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the analytic used to get analytics for a specific short link. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get optimal posting times based on historical performance

**Slug:** `TIMETOPOST_GET_OPTIMAL_POSTING_TIMES`

Get optimal posting times based on historical performance Requires TimeToPost STARTER or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("instagram" | "twitter" | "youtube" | "linkedin" | "tiktok" | "facebook") | No | Filter by specific platform Allowed values: instagram, twitter, youtube, linkedin, tiktok, facebook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all campaigns

**Slug:** `TIMETOPOST_GET_OUTREACH_CAMPAIGNS`

Get all campaigns Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("DRAFT" | "ACTIVE" | "PAUSED" | "COMPLETED" | "ARCHIVED") | No | Status value used to get all campaigns via GET /api/outreach/campaigns. Allowed values: DRAFT, ACTIVE, PAUSED, COMPLETED, ARCHIVED. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a campaign by ID

**Slug:** `TIMETOPOST_GET_OUTREACH_CAMPAIGNS_ID`

Get a campaign by ID Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the campaign used to get a campaign by ID. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all outreach contacts

**Slug:** `TIMETOPOST_GET_OUTREACH_CONTACTS`

Get all outreach contacts Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Tag value used to get all outreach contacts via GET /api/outreach-contacts. |
| `page` | integer | No | Page value used to get all outreach contacts via GET /api/outreach-contacts. |
| `limit` | integer | No | Limit value used to get all outreach contacts via GET /api/outreach-contacts. |
| `search` | string | No | Search value used to get all outreach contacts via GET /api/outreach-contacts. |
| `status` | string | No | Status value used to get all outreach contacts via GET /api/outreach-contacts. |
| `backlink_id` | string | No | Backlink id value used to get all outreach contacts via GET /api/outreach-contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a contact by ID

**Slug:** `TIMETOPOST_GET_OUTREACH_CONTACTS_ID`

Get a contact by ID Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the outreach contact used to get a contact by ID. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all unique tags

**Slug:** `TIMETOPOST_GET_OUTREACH_CONTACTS_TAGS_LIST`

Get all unique tags Requires TimeToPost PRO.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all outreach emails

**Slug:** `TIMETOPOST_GET_OUTREACH_EMAILS`

Get all outreach emails Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page value used to get all outreach emails via GET /api/outreach/emails. |
| `limit` | integer | No | Limit value used to get all outreach emails via GET /api/outreach/emails. |
| `status` | string | No | Status value used to get all outreach emails via GET /api/outreach/emails. |
| `contact_id` | string | No | Contact id value used to get all outreach emails via GET /api/outreach/emails. |
| `campaign_id` | string | No | Campaign id value used to get all outreach emails via GET /api/outreach/emails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an email by ID

**Slug:** `TIMETOPOST_GET_OUTREACH_EMAILS_ID`

Get an email by ID Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the email used to get an email by ID. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get follow-ups

**Slug:** `TIMETOPOST_GET_OUTREACH_FOLLOW_UPS`

Get follow-ups Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("PENDING" | "SCHEDULED" | "SENT" | "SKIPPED" | "CANCELLED") | No | Status value used to get follow-ups via GET /api/outreach/follow-ups. Allowed values: PENDING, SCHEDULED, SENT, SKIPPED, CANCELLED. |
| `email_id` | string | No | Email id value used to get follow-ups via GET /api/outreach/follow-ups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Whether this org can send outreach right now, and the cap usage

**Slug:** `TIMETOPOST_GET_OUTREACH_SEND_STATUS`

Whether this org can send outreach right now, and the cap usage Requires TimeToPost PRO.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get outreach dashboard statistics

**Slug:** `TIMETOPOST_GET_OUTREACH_STATS`

Get outreach dashboard statistics Requires TimeToPost PRO.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### The org's global opt-out list

**Slug:** `TIMETOPOST_GET_OUTREACH_SUPPRESSIONS`

The org's global opt-out list Requires TimeToPost PRO.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Post

**Slug:** `TIMETOPOST_GET_POST`

Get one post by ID with its draft, scheduling, publication, media, and error details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | ID of the post to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get post publishing history

**Slug:** `TIMETOPOST_GET_POST_RESULTS_HISTORY`

Get post publishing history

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get results for a specific post

**Slug:** `TIMETOPOST_GET_POST_RESULTS_POSTID`

Get results for a specific post

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get success rate statistics

**Slug:** `TIMETOPOST_GET_POST_RESULTS_STATS_SUCCESS_RATE`

Get success rate statistics

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | No | Get success rate for specific post |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get scheduler status

**Slug:** `TIMETOPOST_GET_SCHEDULER_STATUS`

Get scheduler status

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all SEO categories

**Slug:** `TIMETOPOST_GET_SEO_CATEGORIES`

Get all SEO categories

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get generation job status

**Slug:** `TIMETOPOST_GET_SEO_GENERATE_JOBID`

Get generation job status

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | ID of the generate used to get generation job status. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all SEO pages

**Slug:** `TIMETOPOST_GET_SEO_PAGES`

Get all SEO pages

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Limit value used to get all SEO pages via GET /api/seo/pages. |
| `offset` | number | No | Offset value used to get all SEO pages via GET /api/seo/pages. |
| `status` | string | No | Status value used to get all SEO pages via GET /api/seo/pages. |
| `category` | string | No | Category value used to get all SEO pages via GET /api/seo/pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get single SEO page

**Slug:** `TIMETOPOST_GET_SEO_PAGES_ID`

Get single SEO page

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the page used to get single SEO page. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SEO system statistics

**Slug:** `TIMETOPOST_GET_SEO_STATISTICS`

Get SEO system statistics

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all SEO templates

**Slug:** `TIMETOPOST_GET_SEO_TEMPLATES`

Get all SEO templates

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get single template

**Slug:** `TIMETOPOST_GET_SEO_TEMPLATES_ID`

Get single template

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the template used to get single template. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Integrations

**Slug:** `TIMETOPOST_LIST_INTEGRATIONS`

List integration availability and connected social accounts. Use integration IDs from returned account records as account IDs for exact post targeting; configured alone does not mean an account is connected.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Posts

**Slug:** `TIMETOPOST_LIST_POSTS`

List all posts in the active organization, newest first, including draft, schedule, targeting, publication status, media, and errors when present.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read an endpoint's delivery history, retained for 30 days.

**Slug:** `TIMETOPOST_LIST_WEBHOOK_DELIVERIES`

Read an endpoint's delivery history, retained for 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Webhook endpoint ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webhook endpoints for the active organization and return the supported subscription event types.

**Slug:** `TIMETOPOST_LIST_WEBHOOK_ENDPOINTS`

List webhook endpoints for the active organization and return the supported subscription event types.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a backlink opportunity

**Slug:** `TIMETOPOST_UPDATE_BACKLINKS_ID`

Update a backlink opportunity Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the backlink used to update a backlink opportunity. Obtain it from the corresponding list or get action. |
| `url` | string | No | Url to use when requesting: Update a backlink opportunity. |
| `niche` | string | No | Niche to use when requesting: Update a backlink opportunity. |
| `notes` | string | No | Notes to use when requesting: Update a backlink opportunity. |
| `domain` | string | No | Domain to use when requesting: Update a backlink opportunity. |
| `keywords` | array | No | Keywords to use when requesting: Update a backlink opportunity. |
| `priority` | string | No | Priority to use when requesting: Update a backlink opportunity. |
| `page_type` | string | No | Page type to use when requesting: Update a backlink opportunity. |
| `page_title` | string | No | Page title to use when requesting: Update a backlink opportunity. |
| `spam_score` | integer | No | Spam score to use when requesting: Update a backlink opportunity. |
| `page_authority` | integer | No | Page authority to use when requesting: Update a backlink opportunity. |
| `relevance_score` | integer | No | Relevance score to use when requesting: Update a backlink opportunity. |
| `domain_authority` | integer | No | Domain authority to use when requesting: Update a backlink opportunity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a company profile

**Slug:** `TIMETOPOST_UPDATE_COMPANY_PROFILES_ID`

Update a company profile Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the company profile used to update a company profile. Obtain it from the corresponding list or get action. |
| `logo` | string | No | Logo to use when requesting: Update a company profile. |
| `name` | string | No | Name to use when requesting: Update a company profile. |
| `website` | string | No | Website to use when requesting: Update a company profile. |
| `industry` | string | No | Industry to use when requesting: Update a company profile. |
| `description` | string | No | Description to use when requesting: Update a company profile. |
| `target_audience` | string | No | Target audience to use when requesting: Update a company profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a content batch

**Slug:** `TIMETOPOST_UPDATE_CONTENT_BATCHES_ID`

Update a content batch Requires an active TimeToPost subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the content batche used to update a content batch. Obtain it from the corresponding list or get action. |
| `name` | string | No | Name to use when requesting: Update a content batch. |
| `status` | string | No | Status to use when requesting: Update a content batch. |
| `description` | string | No | Description to use when requesting: Update a content batch. |
| `variables_data` | array | No | Variables data to use when requesting: Update a content batch. |
| `template_content` | string | No | Template content to use when requesting: Update a content batch. |
| `variables_schema` | object | No | Variables schema to use when requesting: Update a content batch. |
| `variables_source` | string | No | Variables source to use when requesting: Update a content batch. |
| `template_metadata` | object | No | Template metadata to use when requesting: Update a content batch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an email template

**Slug:** `TIMETOPOST_UPDATE_EMAIL_TEMPLATES_ID`

Update an email template Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the email template used to update an email template. Obtain it from the corresponding list or get action. |
| `body` | string | No | Body to use when requesting: Update an email template. |
| `name` | string | No | Name to use when requesting: Update an email template. |
| `type` | string ("INITIAL" | "FOLLOW_UP_1" | "FOLLOW_UP_2" | "FOLLOW_UP_3" | "THANK_YOU" | "CUSTOM") | No | Type to use when requesting: Update an email template. Allowed values: INITIAL, FOLLOW_UP_1, FOLLOW_UP_2, FOLLOW_UP_3, THANK_YOU, CUSTOM. |
| `subject` | string | No | Subject to use when requesting: Update an email template. |
| `category` | string | No | Category to use when requesting: Update an email template. |
| `is_default` | boolean | No | Is default to use when requesting: Update an email template. |
| `description` | string | No | Description to use when requesting: Update an email template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update integration account display name and group

**Slug:** `TIMETOPOST_UPDATE_INTEGRATIONS_ACCOUNT_INTEGRATIONID_UPDATE`

Update integration account display name and group Invocation requirement: provide at least one of displayName, groupName.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_name` | string | No | Group name to use when requesting: Update integration account display name and group. Provide at least one of: displayName, groupName. |
| `display_name` | string | No | Display name to use when requesting: Update integration account display name and group. Provide at least one of: displayName, groupName. |
| `integration_id` | string | Yes | ID of the account used to update integration account display name and group. Obtain it from the corresponding list or get action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a short link

**Slug:** `TIMETOPOST_UPDATE_LINKS_ID`

Update a short link Requires TimeToPost STARTER or higher.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the link used to update a short link. Obtain it from the corresponding list or get action. |
| `title` | string | No | Title to use when requesting: Update a short link. |
| `is_active` | boolean | No | Is active to use when requesting: Update a short link. |
| `expires_at` | string | No | Expires at to use when requesting: Update a short link. |
| `utm_medium` | string | No | Utm medium to use when requesting: Update a short link. |
| `utm_source` | string | No | Utm source to use when requesting: Update a short link. |
| `utm_campaign` | string | No | Utm campaign to use when requesting: Update a short link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a campaign

**Slug:** `TIMETOPOST_UPDATE_OUTREACH_CAMPAIGNS_ID`

Update a campaign Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the campaign used to update a campaign. Obtain it from the corresponding list or get action. |
| `goal` | string | No | Goal to use when requesting: Update a campaign. |
| `name` | string | No | Name to use when requesting: Update a campaign. |
| `end_date` | string | No | End date to use when requesting: Update a campaign. |
| `start_date` | string | No | Start date to use when requesting: Update a campaign. |
| `description` | string | No | Description to use when requesting: Update a campaign. |
| `max_follow_ups` | integer | No | Max follow ups to use when requesting: Update a campaign. |
| `daily_send_limit` | integer | No | Daily send limit to use when requesting: Update a campaign. |
| `follow_up_enabled` | boolean | No | Follow up enabled to use when requesting: Update a campaign. |
| `follow_up_delay_days` | integer | No | Follow up delay days to use when requesting: Update a campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a contact

**Slug:** `TIMETOPOST_UPDATE_OUTREACH_CONTACTS_ID`

Update a contact Requires TimeToPost PRO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the outreach contact used to update a contact. Obtain it from the corresponding list or get action. |
| `tags` | array | No | Tags to use when requesting: Update a contact. |
| `email` | string | No | Email to use when requesting: Update a contact. |
| `notes` | string | No | Notes to use when requesting: Update a contact. |
| `phone` | string | No | Phone to use when requesting: Update a contact. |
| `source` | string | No | Source to use when requesting: Update a contact. |
| `company` | string | No | Company to use when requesting: Update a contact. |
| `website` | string | No | Website to use when requesting: Update a contact. |
| `job_title` | string | No | Job title to use when requesting: Update a contact. |
| `last_name` | string | No | Last name to use when requesting: Update a contact. |
| `first_name` | string | No | First name to use when requesting: Update a contact. |
| `twitter_url` | string | No | Twitter url to use when requesting: Update a contact. |
| `linkedin_url` | string | No | Linkedin url to use when requesting: Update a contact. |
| `backlink_opportunity_id` | string | No | Backlink opportunity id to use when requesting: Update a contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partially update a webhook endpoint.

**Slug:** `TIMETOPOST_UPDATE_WEBHOOK_ENDPOINT`

Partially update a webhook endpoint. Provide at least one field to change: url, events, description, enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Webhook endpoint ID. |
| `url` | string | No | HTTPS endpoint URL on port 443. TimeToPost requires it to resolve to a public address and documents that its delivery service rejects private, loopback, link-local, and cloud-metadata addresses, then rechecks and pins the address when delivering events. Mercury performs only advisory syntax and literal-host checks. Provide at least one of: url, events, description, enabled. |
| `events` | array | No | Replacement webhook event subscriptions. Provide at least one of: url, events, description, enabled. |
| `enabled` | string | No | Endpoint enabled value. The provider does not document its wire type. Provide at least one of: url, events, description, enabled. |
| `description` | string | No | Endpoint description. The provider does not document its wire type. Provide at least one of: url, events, description, enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
