# Zilfu
- **OpenAPI Version:** `3.1.0`
- **API Version:** `0.0.1`
## Servers
- **URL:** `https://zilfu.app/api`
- **Description:** Production
## Schemas
### AccountPostsResource
- **Type:**`object`
* **`account` (required)**
`object` — The account whose posts these are.
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string | null`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string | null`
- **`id` (required)**
`integer`
- **`social` (required)**
`string`
* **`collection` (required)**
`object` — Whether collection is ok, partial, paused, disconnected, unsupported or has never run.
- **`cadence_hours` (required)**
`integer`
- **`last_collected_at` (required)**
`string | null`
- **`polling_window_days` (required)**
`integer`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`state` (required)**
`string`
* **`columns` (required)**
`array` — The metric columns this platform declares, in catalogue order, each with its own health.
**Items:**
- **`definition` (required)**
`string`
- **`headline` (required)**
`boolean`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`reason` (required)**
`string | null`
- **`status` (required)**
`string`
- **`unit` (required)**
`string`
* **`contract` (required)**
`string` — The payload contract version, e.g. \`analytics.v1\`. Shared with the report; the URL is never versioned.
* **`data` (required)**
`array` — One row per post on this page.
**Items:**
- **`excerpt` (required)**
`string`
- **`imported` (required)**
`boolean`
- **`interactions` (required)**
`object`
- **`components` (required)**
`object | null`
- **`reason` (required)**
`string | null`
- **`source` (required)**
`string`
- **`status` (required)**
`string`
- **`total` (required)**
`integer | null`
- **`metrics` (required)**
`object`
- **`permalink` (required)**
`string | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`
- **`thumbnail` (required)**
`string | null`
* **`meta` (required)**
`object` — Where this page sits in the range's posts.
- **`current_page` (required)**
`integer`
- **`last_page` (required)**
`integer`
- **`per_page` (required)**
`integer`
- **`total` (required)**
`integer`
* **`range` (required)**
`object` — The window the posts were published in, and its timezone.
- **`days` (required)**
`integer`
- **`from` (required)**
`string`
- **`previous_from` (required)**
`string`
- **`previous_to` (required)**
`string`
- **`timezone` (required)**
`string`
- **`to` (required)**
`string`
* **`sort` (required)**
`object` — The ordering that was applied, and every key this account can be ordered by.
- **`direction` (required)**
`string`
- **`key` (required)**
`string`
- **`options` (required)**
`array`
**Items:**
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`reason` (required)**
`string | null`
- **`sortable` (required)**
`boolean`
**Example:**
```json
{
"contract": "",
"account": {
"id": 1,
"social": "",
"display_name": "",
"handler": null,
"avatar": null,
"disconnected_at": null
},
"range": {
"from": "",
"to": "",
"timezone": "",
"days": 1,
"previous_from": "",
"previous_to": ""
},
"collection": {
"state": "",
"reason": null,
"remedy": null,
"last_collected_at": null,
"cadence_hours": 1,
"polling_window_days": 1
},
"sort": {
"key": "",
"direction": "",
"options": [
{
"key": "",
"label": "",
"sortable": true,
"reason": null
}
]
},
"columns": [
{
"key": "",
"label": "",
"definition": "",
"unit": "",
"headline": true,
"status": "",
"reason": null
}
],
"data": [
{
"post_id": 1,
"published_at": null,
"permalink": null,
"imported": true,
"excerpt": "",
"thumbnail": null,
"metrics": {
"additionalProperty": {
"value": null,
"status": "",
"reason": null
}
},
"interactions": {
"total": null,
"source": "",
"components": null,
"status": "",
"reason": null
}
}
],
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 1,
"total": 1
}
}
```
### AccountReportResource
- **Type:**`object`
* **`account` (required)**
`object` — The account the report describes.
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string | null`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string | null`
- **`id` (required)**
`integer`
- **`social` (required)**
`string`
* **`audience` (required)**
`object` — Account-level history — followers and every other declared account metric.
- **`metrics` (required)**
`array`
**Items:**
`string`
- **`points` (required)**
`array`
**Items:**
- **`date` (required)**
`string`
- **`values` (required)**
`object`
- **`supported` (required)**
`boolean`
- **`change`**
`object`
- **`labels`**
`object`
- **`latest`**
`object | null`
- **`date` (required)**
`string`
- **`values` (required)**
`object`
* **`basis` (required)**
`object | null` — What the numbers are counted on, and whether the comparison cohort has had time to mature.
- **`comparison_immature` (required)**
`boolean`
- **`note` (required)**
`string`
- **`series` (required)**
`string`
- **`values` (required)**
`string`
* **`best_times` (required)**
`object | null` — The fixed 90-day day-and-hour grid.
- **`best` (required)**
`object | null`
- **`average` (required)**
`number`
- **`hour` (required)**
`integer`
- **`posts` (required)**
`integer`
- **`weekday` (required)**
`integer`
- **`cells` (required)**
`array`
**Items:**
- **`average` (required)**
`number`
- **`hour` (required)**
`integer`
- **`posts` (required)**
`integer`
- **`weekday` (required)**
`integer`
- **`lookback_days` (required)**
`integer`
- **`max_average` (required)**
`number`
- **`min_posts` (required)**
`integer`
- **`reason` (required)**
`string | null`
- **`status` (required)**
`string`
- **`timezone` (required)**
`string`
* **`collection` (required)**
`object` — Whether collection is ok, partial, paused, disconnected, unsupported or has never run.
- **`cadence_hours` (required)**
`integer`
- **`last_collected_at` (required)**
`string | null`
- **`polling_window_days` (required)**
`integer`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`state` (required)**
`string`
* **`contract` (required)**
`string` — The payload contract version, e.g. \`analytics.v1\`. The URL is never versioned.
* **`coverage` (required)**
`object | null` — How many posts and days the range actually rests on.
- **`days_in_range` (required)**
`integer`
- **`days_with_posts` (required)**
`integer`
- **`posts_imported` (required)**
`integer`
- **`posts_in_range` (required)**
`integer`
* **`headline_metric` (required)**
`string | null` — The key of the metric this platform leads with, if any.
* **`interactions` (required)**
`object | null` — The account's interaction score, whether the platform reports one natively, and what this range's score was built from.
- **`change_pct` (required)**
`number | null`
- **`change_unit` (required)**
`string`
- **`components` (required)**
`array`
**Items:**
`string`
- **`definition` (required)**
`string`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`native` (required)**
`boolean`
- **`previous` (required)**
`integer | null`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`source` (required)**
`string`
- **`status` (required)**
`string`
- **`value` (required)**
`integer | null`
* **`metrics` (required)**
`array` — Every metric this platform declares, with its definition, unit and current health.
**Items:**
- **`accumulation` (required)**
`string`
- **`chartable` (required)**
`boolean`
- **`definition` (required)**
`string`
- **`headline` (required)**
`boolean`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`role` (required)**
`string`
- **`scope` (required)**
`string`
- **`status` (required)**
`string`
- **`unit` (required)**
`string`
- **`window_days` (required)**
`integer | null`
* **`range` (required)**
`object` — The reporting window, its timezone and the preceding comparison window.
- **`days` (required)**
`integer`
- **`from` (required)**
`string`
- **`previous_from` (required)**
`string`
- **`previous_to` (required)**
`string`
- **`timezone` (required)**
`string`
- **`to` (required)**
`string`
* **`rates` (required)**
`array` — Declared rates, each naming what it divided by.
**Items:**
- **`basis` (required)**
`string`
- **`change_pp` (required)**
`number | null`
- **`change_unit` (required)**
`string`
- **`definition` (required)**
`string`
- **`denominator_key` (required)**
`string`
- **`denominator_label` (required)**
`string | null`
- **`denominator_unit` (required)**
`string | null`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`numerator_key` (required)**
`string`
- **`per_post_mean` (required)**
`number | null`
- **`previous` (required)**
`number | null`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`status` (required)**
`string`
- **`value` (required)**
`number | null`
* **`series` (required)**
`object | null` — The daily publish-date cohort series.
- **`basis` (required)**
`string`
- **`interval` (required)**
`string`
- **`metrics` (required)**
`array`
**Items:**
`string`
- **`note` (required)**
`string`
- **`points` (required)**
`array`
**Items:**
- **`date` (required)**
`string`
- **`posts` (required)**
`integer`
- **`values` (required)**
`object | null`
- **`timezone` (required)**
`string`
- **`values` (required)**
`string`
* **`totals` (required)**
`array` — Summed post metrics for the range, each against the previous window.
**Items:**
- **`change_pct` (required)**
`number | null`
- **`change_unit` (required)**
`string`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`previous` (required)**
`integer | null`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`status` (required)**
`string`
- **`unit` (required)**
`string`
- **`value` (required)**
`integer | null`
**Example:**
```json
{
"contract": "",
"account": {
"id": 1,
"social": "",
"display_name": "",
"handler": null,
"avatar": null,
"disconnected_at": null
},
"range": {
"from": "",
"to": "",
"timezone": "",
"days": 1,
"previous_from": "",
"previous_to": ""
},
"basis": {
"series": "",
"values": "",
"note": "",
"comparison_immature": true
},
"collection": {
"state": "",
"reason": null,
"remedy": null,
"last_collected_at": null,
"cadence_hours": 1,
"polling_window_days": 1
},
"coverage": {
"posts_in_range": 1,
"posts_imported": 1,
"days_in_range": 1,
"days_with_posts": 1
},
"metrics": [
{
"key": "",
"label": "",
"definition": "",
"unit": "",
"accumulation": "",
"scope": "",
"role": "",
"window_days": null,
"headline": true,
"chartable": true,
"status": "",
"reason": null,
"remedy": null
}
],
"headline_metric": null,
"totals": [
{
"key": "",
"label": "",
"unit": "",
"value": null,
"previous": null,
"change_pct": null,
"change_unit": "",
"status": "",
"reason": null,
"remedy": null
}
],
"interactions": {
"key": "",
"label": "",
"definition": "",
"native": true,
"source": "",
"components": [
""
],
"value": null,
"previous": null,
"change_pct": null,
"change_unit": "",
"status": "",
"reason": null,
"remedy": null
},
"rates": [
{
"key": "",
"label": "",
"definition": "",
"numerator_key": "",
"denominator_key": "",
"denominator_label": null,
"denominator_unit": null,
"basis": "",
"value": null,
"per_post_mean": null,
"previous": null,
"change_pp": null,
"change_unit": "",
"status": "",
"reason": null,
"remedy": null
}
],
"series": {
"basis": "",
"values": "",
"note": "",
"interval": "",
"timezone": "",
"metrics": [
""
],
"points": [
{
"date": "",
"posts": 1,
"values": null
}
]
},
"audience": {
"supported": true,
"metrics": [
""
],
"points": [
{
"date": "",
"values": {
"additionalProperty": 1
}
}
],
"labels": {
"additionalProperty": ""
},
"latest": {
"date": "",
"values": {
"additionalProperty": 1
}
},
"change": {
"additionalProperty": 1
}
},
"best_times": {
"cells": [
{
"weekday": 1,
"hour": 1,
"posts": 1,
"average": 1
}
],
"best": {
"weekday": 1,
"hour": 1,
"posts": 1,
"average": 1
},
"timezone": "",
"lookback_days": 1,
"min_posts": 1,
"max_average": 1,
"status": "",
"reason": null
}
}
```
### AccountReportSummaryResource
- **Type:**`object`
* **`account` (required)**
`object` — The account this row describes.
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string | null`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string | null`
- **`id` (required)**
`integer`
- **`social` (required)**
`string`
* **`collection` (required)**
`object` — Whether collection is ok, partial, paused, disconnected, unsupported or has never run.
- **`cadence_hours` (required)**
`integer`
- **`last_collected_at` (required)**
`string | null`
- **`polling_window_days` (required)**
`integer`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`state` (required)**
`string`
* **`coverage` (required)**
`object | null` — How many posts and days the range actually rests on.
- **`days_in_range` (required)**
`integer`
- **`days_with_posts` (required)**
`integer`
- **`posts_imported` (required)**
`integer`
- **`posts_in_range` (required)**
`integer`
* **`headline_metric` (required)**
`string | null` — The key of the metric this platform leads with, if any.
* **`interactions` (required)**
`object | null` — The account's interaction score, whether the platform reports one natively, and what this range's score was built from.
- **`change_pct` (required)**
`number | null`
- **`change_unit` (required)**
`string`
- **`components` (required)**
`array`
**Items:**
`string`
- **`definition` (required)**
`string`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`native` (required)**
`boolean`
- **`previous` (required)**
`integer | null`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`source` (required)**
`string`
- **`status` (required)**
`string`
- **`value` (required)**
`integer | null`
* **`rates` (required)**
`array` — Declared rates, each naming what it divided by.
**Items:**
- **`basis` (required)**
`string`
- **`change_pp` (required)**
`number | null`
- **`change_unit` (required)**
`string`
- **`definition` (required)**
`string`
- **`denominator_key` (required)**
`string`
- **`denominator_label` (required)**
`string | null`
- **`denominator_unit` (required)**
`string | null`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`numerator_key` (required)**
`string`
- **`per_post_mean` (required)**
`number | null`
- **`previous` (required)**
`number | null`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`status` (required)**
`string`
- **`value` (required)**
`number | null`
* **`totals` (required)**
`array` — Summed post metrics for the range, each against the previous window.
**Items:**
- **`change_pct` (required)**
`number | null`
- **`change_unit` (required)**
`string`
- **`key` (required)**
`string`
- **`label` (required)**
`string`
- **`previous` (required)**
`integer | null`
- **`reason` (required)**
`string | null`
- **`remedy` (required)**
`string | null`
- **`status` (required)**
`string`
- **`unit` (required)**
`string`
- **`value` (required)**
`integer | null`
**Example:**
```json
{
"account": {
"id": 1,
"social": "",
"display_name": "",
"handler": null,
"avatar": null,
"disconnected_at": null
},
"collection": {
"state": "",
"reason": null,
"remedy": null,
"last_collected_at": null,
"cadence_hours": 1,
"polling_window_days": 1
},
"headline_metric": null,
"totals": [
{
"key": "",
"label": "",
"unit": "",
"value": null,
"previous": null,
"change_pct": null,
"change_unit": "",
"status": "",
"reason": null,
"remedy": null
}
],
"interactions": {
"key": "",
"label": "",
"definition": "",
"native": true,
"source": "",
"components": [
""
],
"value": null,
"previous": null,
"change_pct": null,
"change_unit": "",
"status": "",
"reason": null,
"remedy": null
},
"rates": [
{
"key": "",
"label": "",
"definition": "",
"numerator_key": "",
"denominator_key": "",
"denominator_label": null,
"denominator_unit": null,
"basis": "",
"value": null,
"per_post_mean": null,
"previous": null,
"change_pp": null,
"change_unit": "",
"status": "",
"reason": null,
"remedy": null
}
],
"coverage": {
"posts_in_range": 1,
"posts_imported": 1,
"days_in_range": 1,
"days_with_posts": 1
}
}
```
### AccountResource
- **Type:**`object`
* **`avatar` (required)**
`string | null`
* **`disconnected_at` (required)**
`string`
* **`display_name` (required)**
`string`
* **`handler` (required)**
`string`
* **`id` (required)**
`integer`
* **`is_active` (required)**
`boolean`
* **`profile_url` (required)**
`string`
* **`social` (required)**
`string`
**Example:**
```json
{
"id": 1,
"social": "",
"display_name": "",
"handler": "",
"profile_url": "",
"avatar": null,
"is_active": true,
"disconnected_at": ""
}
```
### BioBlockResource
- **Type:**`object`
* **`content` (required)**
`array`
**Items:**
* **`id` (required)**
`integer`
* **`is_visible` (required)**
`boolean`
* **`sort_order` (required)**
`integer`
* **`type` (required)**
`string`
* **`embed`**
`string`
* **`image_url`**
`string`
**Example:**
```json
{
"id": 1,
"type": "",
"content": [],
"sort_order": 1,
"is_visible": true,
"image_url": "",
"embed": ""
}
```
### BioPageResource
- **Type:**`object`
* **`avatar` (required)**
`string`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`description` (required)**
`string | null`
* **`id` (required)**
`integer`
* **`is_enabled` (required)**
`boolean`
* **`public_url` (required)**
`string`
* **`settings` (required)**
`object`
- **`btn_radius` (required)**
`string`
- **`colors` (required)**
`array`
**Items:**
- **`font` (required)**
`string`
* **`slug` (required)**
`string`
* **`theme` (required)**
`string`
* **`title` (required)**
`string | null`
* **`updated_at` (required)**
`string | null`, format: `date-time`
**Example:**
```json
{
"id": 1,
"slug": "",
"title": null,
"description": null,
"theme": "",
"settings": {
"colors": [],
"btn_radius": "",
"font": ""
},
"avatar": "",
"is_enabled": true,
"public_url": "",
"created_at": null,
"updated_at": null
}
```
### IngestMediaRequest
- **Type:**`object`
* **`url` (required)**
`string`
* **`mime`**
`string | null`
* **`name`**
`string | null`
* **`type`**
`string | null`
**Example:**
```json
{
"url": "",
"type": null,
"mime": null,
"name": null
}
```
### MediaResource
- **Type:**`object`
* **`alt` (required)**
`string`
* **`height` (required)**
`string`
* **`id` (required)**
`string`
* **`mime` (required)**
`string`
* **`name` (required)**
`string`
* **`order` (required)**
`string`
* **`size` (required)**
`string`
* **`type` (required)**
`string`
* **`url` (required)**
`string`
* **`width` (required)**
`string`
**Example:**
```json
{
"id": "",
"type": "",
"url": "",
"name": "",
"mime": "",
"width": "",
"height": "",
"size": "",
"alt": "",
"order": ""
}
```
### PostResource
- **Type:**`object`
* **`account_id` (required)**
`integer`
* **`analytics` (required)**
`array | null`
* **`cluster_id` (required)**
`string`
* **`content` (required)**
`string`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`id` (required)**
`integer`
* **`metadata` (required)**
`array | null`
* **`order` (required)**
`integer`
* **`parent_id` (required)**
`integer | null`
* **`published_at` (required)**
`string | null`, format: `date-time`
* **`scheduled_at` (required)**
`string | null`, format: `date-time`
* **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
* **`updated_at` (required)**
`string | null`, format: `date-time`
* **`user_id` (required)**
`integer`
* **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
* **`analytics_metrics`**
`array`
**Items:**
* **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
- **`avatar` (required)**
`string | null`
- **`disconnected_at` (required)**
`string`
- **`display_name` (required)**
`string`
- **`handler` (required)**
`string`
- **`id` (required)**
`integer`
- **`is_active` (required)**
`boolean`
- **`profile_url` (required)**
`string`
- **`social` (required)**
`string`
- **`analytics_metrics`**
`array`
**Items:**
- **`children`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`analytics` (required)**
`array | null`
- **`cluster_id` (required)**
`string`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`order` (required)**
`integer`
- **`parent_id` (required)**
`integer | null`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5`
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`user_id` (required)**
`integer`
- **`account`**
`object`
*\[Circular Reference]*
- **`analytics_metrics`**
`array`
**Items:**
*\[Circular Reference]*
- **`children`**
`array`
**Items:**
*\[Circular Reference]*
- **`media`**
`array`
**Items:**
*\[Circular Reference]*
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
*\[Circular Reference]*
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
- **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
- **`review`**
`object`
- **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
- **`type`**
`object`
* **`media`**
`array`
**Items:**
- **`alt` (required)**
`string`
- **`height` (required)**
`string`
- **`id` (required)**
`string`
- **`mime` (required)**
`string`
- **`name` (required)**
`string`
- **`order` (required)**
`string`
- **`size` (required)**
`string`
- **`type` (required)**
`string`
- **`url` (required)**
`string`
- **`width` (required)**
`string`
* **`review`**
`object`
* **`scheduled_comments`**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`content` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`delay_minutes` (required)**
`integer`
- **`id` (required)**
`integer`
- **`metadata` (required)**
`array | null`
- **`post_id` (required)**
`integer`
- **`published_at` (required)**
`string | null`, format: `date-time`
- **`scheduled_at` (required)**
`string | null`, format: `date-time`
- **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
- **`updated_at` (required)**
`string | null`, format: `date-time`
* **`type`**
`object`
**Example:**
```json
{
"id": 1,
"content": "",
"status": 0,
"order": 1,
"scheduled_at": null,
"published_at": null,
"metadata": [],
"type": "",
"cluster_id": "",
"parent_id": null,
"user_id": 1,
"account_id": 1,
"created_at": null,
"updated_at": null,
"analytics": [],
"analytics_metrics": [],
"account": {
"id": 1,
"social": "",
"display_name": "",
"handler": "",
"profile_url": "",
"avatar": null,
"is_active": true,
"disconnected_at": ""
},
"children": [
{
"id": 1,
"content": "",
"status": null,
"order": 1,
"scheduled_at": null,
"published_at": null,
"metadata": [],
"type": "",
"cluster_id": "",
"parent_id": null,
"user_id": 1,
"account_id": 1,
"created_at": null,
"updated_at": null,
"analytics": [],
"analytics_metrics": [],
"account": null,
"scheduled_comments": [],
"media": [],
"review": null
}
],
"scheduled_comments": [
{
"id": 1,
"content": "",
"status": null,
"delay_minutes": 1,
"scheduled_at": null,
"published_at": null,
"metadata": [],
"post_id": 1,
"account_id": 1,
"created_at": null,
"updated_at": null
}
],
"media": [
{
"id": "",
"type": "",
"url": "",
"name": "",
"mime": "",
"width": "",
"height": "",
"size": "",
"alt": "",
"order": ""
}
],
"review": {
"id": 1,
"post_id": 1,
"decision": null,
"publish_now": true,
"requested_at": null,
"decided_at": null,
"scheduled_at": null,
"requested_by": {
"id": "",
"name": ""
},
"decided_by": {
"type": "member",
"name": ""
},
"comments": []
}
}
```
### PostReviewResource
- **Type:**`object`
* **`decided_at` (required)**
`string | null`, format: `date-time`
* **`decided_by` (required)**
`object | null`
- **`name` (required)**
`string`
- **`type` (required)**
`string`
* **`decision` (required)**
`string | null`
* **`id` (required)**
`integer`
* **`post_id` (required)**
`integer`
* **`publish_now` (required)**
`boolean`
* **`requested_at` (required)**
`string | null`, format: `date-time`
* **`scheduled_at` (required)**
`string | null`, format: `date-time`
* **`comments`**
`array`
**Items:**
- **`author` (required)**
`object`
- **`name` (required)**
`object`
- **`type` (required)**
`string`
- **`body` (required)**
`string`
- **`created_at` (required)**
`string | null`, format: `date-time`
- **`id` (required)**
`integer`
- **`visibility` (required)**
`string`
* **`requested_by`**
`object`
- **`id` (required)**
`string`
- **`name` (required)**
`string`
**Example:**
```json
{
"id": 1,
"post_id": 1,
"decision": null,
"publish_now": true,
"requested_at": null,
"decided_at": null,
"scheduled_at": null,
"requested_by": {
"id": "",
"name": ""
},
"decided_by": {
"type": "member",
"name": ""
},
"comments": [
{
"id": 1,
"body": "",
"visibility": "",
"author": {
"type": "member",
"name": ""
},
"created_at": null
}
]
}
```
### PostStatus
- **Type:**`integer`
**Example:**
### ReviewCommentResource
- **Type:**`object`
* **`author` (required)**
`object`
- **`name` (required)**
`object`
- **`type` (required)**
`string`
* **`body` (required)**
`string`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`id` (required)**
`integer`
* **`visibility` (required)**
`string`
**Example:**
```json
{
"id": 1,
"body": "",
"visibility": "",
"author": {
"type": "member",
"name": ""
},
"created_at": null
}
```
### ScheduledCommentResource
- **Type:**`object`
* **`account_id` (required)**
`integer`
* **`content` (required)**
`string`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`delay_minutes` (required)**
`integer`
* **`id` (required)**
`integer`
* **`metadata` (required)**
`array | null`
* **`post_id` (required)**
`integer`
* **`published_at` (required)**
`string | null`, format: `date-time`
* **`scheduled_at` (required)**
`string | null`, format: `date-time`
* **`status` (required)**
`integer`, possible values: `0, 1, 2, 3, 4, 5, 6` — | | |---| | \`0\` \
Created, waiting for the parent post to publish before it can be armed. | | \`1\` \
Armed with the parent's remote id and an absolute fire time. | | \`2\` \
| | \`3\` \
| | \`4\` \
| | \`5\` \
Parent post failed, so the comment never armed. | | \`6\` \
Cancelled by the user before publishing. |
* **`updated_at` (required)**
`string | null`, format: `date-time`
**Example:**
```json
{
"id": 1,
"content": "",
"status": 0,
"delay_minutes": 1,
"scheduled_at": null,
"published_at": null,
"metadata": [],
"post_id": 1,
"account_id": 1,
"created_at": null,
"updated_at": null
}
```
### ScheduledCommentStatus
- **Type:**`integer`
| |
| --------------------------------------------------------------------------- |
| `0` Created, waiting for the parent post to publish before it can be armed. |
| `1` Armed with the parent's remote id and an absolute fire time. |
| `2` |
| `3` |
| `4` |
| `5` Parent post failed, so the comment never armed. |
| `6` Cancelled by the user before publishing. |
**Example:**
### SessionResource
- **Type:**`object`
* **`email` (required)**
`string`
* **`id` (required)**
`string`
* **`name` (required)**
`string`
**Example:**
```json
{
"id": "",
"name": "",
"email": ""
}
```
### SignMediaRequest
- **Type:**`object`
* **`mime` (required)**
`string`, possible values: `"image/jpeg", "image/png", "image/webp", "video/mp4", "video/quicktime"`
**Example:**
```json
{
"mime": "image/jpeg"
}
```
### SlotResource
- **Type:**`object`
* **`day_of_week` (required)**
`integer`
* **`id` (required)**
`integer`
* **`time` (required)**
`string`
**Example:**
```json
{
"id": 1,
"day_of_week": 1,
"time": ""
}
```
### SpaceInvitationResource
- **Type:**`object`
* **`accepted_at` (required)**
`string | null`, format: `date-time`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`email` (required)**
`string`
* **`expires_at` (required)**
`string`, format: `date-time`
* **`id` (required)**
`integer`
* **`is_expired` (required)**
`boolean`
* **`permissions` (required)**
`object`
**Example:**
```json
{
"id": 1,
"email": "",
"permissions": "",
"expires_at": "",
"accepted_at": null,
"created_at": null,
"is_expired": true
}
```
### SpaceMemberResource
- **Type:**`object`
* **`email` (required)**
`string`
* **`id` (required)**
`integer`
* **`name` (required)**
`string`
* **`joined_at`**
`string`
* **`permissions`**
`object`
**Example:**
```json
{
"id": 1,
"name": "",
"email": "",
"permissions": "",
"joined_at": ""
}
```
### SpacePermission
- **Type:**`string`
**Example:**
### SpaceResource
- **Type:**`object`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`id` (required)**
`integer`
* **`name` (required)**
`string`
* **`timezone` (required)**
`string | null`
* **`updated_at` (required)**
`string | null`, format: `date-time`
**Example:**
```json
{
"id": 1,
"name": "",
"timezone": null,
"created_at": null,
"updated_at": null
}
```
### StoreBioBlockRequest
- **Type:**`object`
* **`content` (required)**
`array`
**Items:**
`string`
* **`type` (required)**
`string`, possible values: `"link", "header", "social_icons", "text", "image", "embed"`
* **`is_visible`**
`boolean`
**Example:**
```json
{
"type": "link",
"content": [
""
],
"is_visible": true
}
```
### StoreBioPageRequest
- **Type:**`object`
* **`slug` (required)**
`string`
* **`theme` (required)**
`string`, possible values: `"minimal", "bold", "neon", "soft", "classic"`
* **`description`**
`string | null`
* **`title`**
`string | null`
**Example:**
```json
{
"slug": "",
"title": null,
"description": null,
"theme": "minimal"
}
```
### StorePostRequest
- **Type:**`object`
* **`items` (required)**
`array`
**Items:**
- **`account_id` (required)**
`integer`
- **`social` (required)**
`string`
- **`children`**
`array | null`
- **`main`**
`object`
- **`content` (required)**
`string`
- **`media`**
`array | null`
- **`metadata`**
`object | null`
- **`allow_comments`**
`boolean | null`
- **`allow_duet`**
`boolean | null`
- **`allow_stitch`**
`boolean | null`
- **`board_id`**
`string | null`
- **`brand_organic`**
`boolean | null`
- **`branded_content`**
`boolean | null`
- **`cover_image_url`**
`string | null`, format: `uri`
- **`link`**
`string | null`, format: `uri`
- **`post_type`**
`string | null`
- **`privacy_level`**
`string | null`
- **`title`**
`string | null`
- **`topic_tag`**
`string | null`
* **`space_id` (required)**
`integer`
* **`at`**
`integer | null`
* **`comment`**
`object`
- **`content`**
`string`
- **`delay_minutes`**
`integer`
* **`is_draft`**
`boolean`
**Example:**
```json
{
"space_id": 1,
"at": null,
"is_draft": true,
"comment": {
"content": "",
"delay_minutes": 1
},
"items": [
{
"account_id": 1,
"social": "",
"children": [
{
"content": "",
"media": [
{
"url": "",
"type": "image"
}
]
}
],
"metadata": {
"topic_tag": null,
"post_type": null,
"link": null,
"privacy_level": null,
"allow_comments": null,
"allow_duet": null,
"allow_stitch": null,
"branded_content": null,
"brand_organic": null,
"board_id": null,
"title": null,
"cover_image_url": null
},
"main": {
"content": "",
"media": [
{
"url": "",
"type": "image"
}
]
}
}
]
}
```
### StoreScheduledCommentRequest
- **Type:**`object`
* **`content` (required)**
`string`
* **`delay_minutes` (required)**
`integer`
**Example:**
```json
{
"content": "",
"delay_minutes": 1
}
```
### StoreSlotRequest
- **Type:**`object`
* **`days_of_week` (required)**
`array`
**Items:**
`integer`
* **`time` (required)**
`string`
**Example:**
```json
{
"time": "",
"days_of_week": [
1
]
}
```
### StoreSpaceInvitationRequest
- **Type:**`object`
* **`email` (required)**
`string`, format: `email`
* **`permissions` (required)**
`array`
**Items:**
`string`, possible values: `"create_posts", "edit_posts", "publish_posts", "approve_posts", "delete_posts", "manage_accounts", "manage_team"`
**Example:**
```json
{
"email": "",
"permissions": [
"create_posts"
]
}
```
### StoreSpaceRequest
- **Type:**`object`
* **`name` (required)**
`string`
**Example:**
```json
{
"name": ""
}
```
### StoreWebhookRequest
- **Type:**`object`
* **`events` (required)**
`array`
**Items:**
`string`, possible values: `"post.published", "post.failed", "post.scheduled", "comment.published", "comment.failed", "comment.received", "account.connected", "account.disconnected"`
* **`url` (required)**
`string`, format: `uri`
**Example:**
```json
{
"url": "",
"events": [
"post.published"
]
}
```
### UpdateBioBlockRequest
- **Type:**`object`
* **`content`**
`array`
**Items:**
`string`
* **`is_visible`**
`boolean`
**Example:**
```json
{
"content": [
""
],
"is_visible": true
}
```
### UpdatePostRequest
- **Type:**`object`
* **`at`**
`integer | null`
* **`children`**
`array | null`
* **`content`**
`string`
* **`is_draft`**
`boolean`
* **`media`**
`array | null`
* **`metadata`**
`object`
- **`allow_comments`**
`boolean | null`
- **`allow_duet`**
`boolean | null`
- **`allow_stitch`**
`boolean | null`
- **`board_id`**
`string | null`
- **`brand_organic`**
`boolean | null`
- **`branded_content`**
`boolean | null`
- **`cover_image_url`**
`string | null`, format: `uri`
- **`link`**
`string | null`, format: `uri`
- **`post_type`**
`string | null`
- **`privacy_level`**
`string | null`
- **`title`**
`string | null`
- **`topic_tag`**
`string | null`
**Example:**
```json
{
"at": null,
"is_draft": true,
"content": "",
"metadata": {
"topic_tag": null,
"post_type": null,
"link": null,
"privacy_level": null,
"allow_comments": null,
"allow_duet": null,
"allow_stitch": null,
"branded_content": null,
"brand_organic": null,
"board_id": null,
"title": null,
"cover_image_url": null
},
"media": [
{
"url": "",
"type": "image"
}
],
"children": [
{
"content": "",
"media": [
{
"url": "",
"type": "image"
}
]
}
]
}
```
### UpdateScheduledCommentRequest
- **Type:**`object`
* **`content`**
`string`
* **`delay_minutes`**
`integer`
**Example:**
```json
{
"content": "",
"delay_minutes": 1
}
```
### UpdateSpaceMemberRequest
- **Type:**`object`
* **`permissions` (required)**
`array`
**Items:**
`string`, possible values: `"create_posts", "edit_posts", "publish_posts", "approve_posts", "delete_posts", "manage_accounts", "manage_team"`
**Example:**
```json
{
"permissions": [
"create_posts"
]
}
```
### UpdateSpaceRequest
- **Type:**`object`
* **`name`**
`string`
* **`timezone`**
`string`
**Example:**
```json
{
"name": "",
"timezone": ""
}
```
### UpdateWebhookRequest
- **Type:**`object`
* **`events`**
`array`
**Items:**
`string`, possible values: `"post.published", "post.failed", "post.scheduled", "comment.published", "comment.failed", "comment.received", "account.connected", "account.disconnected"`
* **`is_active`**
`boolean`
* **`url`**
`string`, format: `uri`
**Example:**
```json
{
"url": "",
"is_active": true,
"events": [
"post.published"
]
}
```
### WebhookResource
- **Type:**`object`
* **`created_at` (required)**
`string | null`, format: `date-time`
* **`events` (required)**
`array`
**Items:**
* **`id` (required)**
`integer`
* **`is_active` (required)**
`boolean`
* **`updated_at` (required)**
`string | null`, format: `date-time`
* **`url` (required)**
`string`
**Example:**
```json
{
"id": 1,
"url": "",
"events": [],
"is_active": true,
"created_at": null,
"updated_at": null
}
```