API reference

Post

The objects, fields and constraints behind the API.

Field	Type & constraints
`id`required	string
`version`required	integer
`xAccountId`required	string \| null
`kind`required	string
`status`required	stringValues: draft, scheduled, queued, publishing, published, failed, canceled.
`scheduledAt`required	integer \| null
`publishedAt`required	integer \| null
`timezone`required	string
`linkInReply`required	boolean
`aiAssisted`required	boolean
`xPostId`required	string \| null
`xPostUrl`required	string \| null
`errorCode`required	string \| null
`attempts`required	integer
`createdAt`required	integer
`updatedAt`required	integer
`deletedAt`required	integer \| null
`items`required	PostItem ↗ []

View JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "version": {
      "type": "integer"
    },
    "xAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "kind": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "scheduled",
        "queued",
        "publishing",
        "published",
        "failed",
        "canceled"
      ]
    },
    "scheduledAt": {
      "type": [
        "integer",
        "null"
      ]
    },
    "publishedAt": {
      "type": [
        "integer",
        "null"
      ]
    },
    "timezone": {
      "type": "string"
    },
    "linkInReply": {
      "type": "boolean"
    },
    "aiAssisted": {
      "type": "boolean"
    },
    "xPostId": {
      "type": [
        "string",
        "null"
      ]
    },
    "xPostUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "attempts": {
      "type": "integer"
    },
    "createdAt": {
      "type": "integer"
    },
    "updatedAt": {
      "type": "integer"
    },
    "deletedAt": {
      "type": [
        "integer",
        "null"
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PostItem"
      }
    }
  },
  "required": [
    "id",
    "version",
    "xAccountId",
    "kind",
    "status",
    "scheduledAt",
    "publishedAt",
    "timezone",
    "linkInReply",
    "aiAssisted",
    "xPostId",
    "xPostUrl",
    "errorCode",
    "attempts",
    "createdAt",
    "updatedAt",
    "deletedAt",
    "items"
  ],
  "additionalProperties": true
}

← All data models