ParrotPosterParrotPoster
API
  • WordPress plugin
Site
  • English
  • Русский
API
  • WordPress plugin
Site
  • English
  • Русский
  • Introduction
  • Quick start
  • API methods

    • Authentication
    • Social accounts
    • Posts

      • Main use cases
      • Post object shape
      • Get post
      • Create post
      • Update post
      • Delete post

Post object shape

This object represents a post created in ParrotPoster.

Post fields

FieldTypeDescription
idIDUnique post ID
statusStringPost status (PREPARE, SUCCESS, READY, etc.)
fieldsObjectPost content (same shape as at creation)
networksObjectWhere to publish
publishAtStringScheduled or actual publish time
results[Object]?Per-network publish results
createdAtStringCreation time
updatedAtStringLast update time

Post status

StatusDescription
PREPAREPreparing for publication
READYReady to publish, waiting for scheduled time
SUCCESSPublished successfully
FAILPublishing failed for at least one network
PUBLISHINGPublishing in progress
UPDATINGPost is being updated
DELETINGPost is being deleted

fields

Describes text content and media.

FieldTypeDescription
textString?Post text
linkString?Link attached to the post
tagsString?Tags (hashtags)
imageIds[ID]?Image ID list
images[Object]?Image objects
fileIds[ID]?File ID list
files[Object]?File objects
neetUtmBoolean?Attach UTM tags
utmParamsObject?UTM parameters
extraObject?Extra options

fields.extra

Extra options for specific networks.

FieldTypeDescription
vkFromGroupBoolean?Publish as the VK community (true) or as the author (false). Default: true
vkSignedBoolean?Add an author signature in VK. Default: false

networks

Defines publish targets.

FieldTypeRequiredDescription
accounts[String]YesAccount IDs from listSocialAccounts

results

Per-network publish results.

FieldTypeDescription
accountIdStringAccount ID
successBooleanWhether publishing succeeded
linkToSocialPostString?URL of the created post in the network
errorMsgString?Error message
Edit on GitHub
Last updated: 4/24/26, 6:09 PM
Prev
Main use cases
Next
Get post