Ayrshare integration (Social, Marketing). Imported from open-connector.
https://api.ayrshare.com/api/user
| Param | Type | Required | Description |
|---|---|---|---|
| instagramDetails | boolean | optional | Whether Ayrshare should include slower additional Instagram details. |
/history
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | The maximum number of history records to return. |
| platforms | array | optional | The social platforms to include in the history filter. |
| startDate | string | optional | The inclusive ISO 8601 start date for history results. |
| endDate | string | optional | The inclusive ISO 8601 end date for history results. |
| lastDays | integer | optional | The number of previous days to include, or 0 for all history. |
| status | string | optional | The Ayrshare post status to filter by. |
| type | string | optional | Whether to return immediate or scheduled posts. |
| autoRepostId | string | optional | The auto repost ID to filter by, or all for every auto repost. |
/post
| Param | Type | Required | Description |
|---|---|---|---|
| post | string | required | The post text to send to the selected social platforms. |
| platforms | array | required | The social platforms to publish to, or all to publish to every linked platform. |
| mediaUrls | array | optional | HTTPS image or video URLs to include in the post. |
| isVideo | boolean | optional | Whether the media URLs should be treated as video media. |
| scheduleDate | string | optional | The UTC ISO 8601 datetime when Ayrshare should publish the post. |
| validateScheduled | boolean | optional | Whether Ayrshare should validate a scheduled post before accepting it. |
| idempotencyKey | string | optional | A unique idempotency key used to reject duplicate post submissions. |
| notes | string | optional | Internal notes stored with the post and retrievable from history. |
/post/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The top-level Ayrshare post ID returned by publish_post. |
/post
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The top-level Ayrshare post ID returned by publish_post. |
| bulk | array | optional | Ayrshare post IDs to bulk delete. |
| deleteAllScheduled | boolean | optional | Whether to delete all pending scheduled posts for the profile. |
| markManualDeleted | boolean | optional | Whether to mark the Ayrshare post as deleted without deleting it from the socia… |
/post
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The top-level Ayrshare post ID returned by publish_post. |
| approved | boolean | optional | Whether to approve a post awaiting approval. |
| disableComments | boolean | optional | Whether to disable comments on supported social platforms. |
| notes | string | optional | Reference notes stored with the Ayrshare post. |
| scheduleDate | string | optional | The UTC datetime when Ayrshare should publish the scheduled post. |
| scheduledPause | boolean | optional | Whether to pause or unpause a scheduled Ayrshare post. |
| youTubeOptions | object | optional | YouTube metadata to update on a posted video. |
/post/retry
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The top-level Ayrshare post ID returned by publish_post. |
/post/checkPostWeight
| Param | Type | Required | Description |
|---|---|---|---|
| post | string | optional | The post text to measure. |
/validate/post
| Param | Type | Required | Description |
|---|---|---|---|
| post | string | required | The post text to validate. |
| platforms | array | required | The social platforms to validate the post against. |
| mediaUrls | array | optional | HTTPS image or video URLs to validate with the post. |
| isVideo | boolean | optional | Whether the media URLs should be treated as video media. |
/media/urlExists
| Param | Type | Required | Description |
|---|---|---|---|
| mediaUrl | string | optional | The media URL Ayrshare should verify. |
/analytics/post
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The top-level Ayrshare post ID returned by publish_post. |
| platforms | array | optional | Optional social platforms to include in the Ayrshare request. |