PostZen
Posts

Get a post

GET
/v1/posts/{postId}

Returns one post when the API key can access the profile of every account the post targets. Missing and inaccessible posts both return 404.

Authorization

bearerAuth
AuthorizationBearer <token>

PostZen API key.

In: header

Path Parameters

postId*string

PostZen post id.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/posts/string"
{  "post": {    "_id": "string",    "title": "string",    "content": "string",    "status": "string",    "scheduledFor": "2019-08-24T14:15:22Z",    "queueId": "string",    "timezone": "string",    "platforms": [      {        "platform": "twitter",        "accountId": {          "_id": "string",          "platform": "twitter",          "username": "string",          "displayName": "string",          "isActive": true        },        "status": "draft",        "platformPostId": "string",        "platformPostIds": [          "string"        ],        "platformPostUrl": "http://example.com",        "error": "string",        "platformError": {          "code": 0,          "subcode": 0,          "fbtraceId": "string",          "type": "string"        },        "customContent": "string",        "settings": {          "postType": "feed",          "collaborators": [            "string"          ],          "userTags": [            {              "username": "string",              "x": 0,              "y": 0            }          ],          "firstComment": "string",          "shareToFeed": true,          "trialParams": {            "graduationStrategy": "MANUAL"          }        }      }    ],    "mediaItems": [      {        "url": "http://example.com",        "title": "string"      }    ]  }}
{  "error": "JSON body is required"}
{  "error": "Unauthorized"}
{  "error": "Not found"}
{  "error": "rate_limited",  "retryAfter": 30}

Create a post POST

Creates a draft, scheduled post, immediate post, or queued post. This endpoint requires a read-write API key. Provide exactly one creation mode: `publishNow`, `scheduledFor`, `isDraft`, or `queuedFromProfile` (optionally with `queueId`), which claims the next free slot in that profile's queue and returns it as `scheduledFor`. The accounts in `platforms` can belong to different profiles; an API key limited to selected profiles must have access to the profile of every account.

Update a post PUT

Updates an editable post. Every body field is optional; omitted fields keep their current values, and omitting all timing fields keeps the current scheduling and draft status. At most one of `publishNow`, `scheduledFor`, `isDraft`, or `queuedFromProfile` may select a new timing mode. Accounts in `platforms` can belong to different profiles; the API key needs access to all of them.