Skip to main content
PATCH
Update an Instagram post

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

post_id
integer
required

ID of the post to update.

Required range: x >= 0

Body

application/json
alt_text_media_map
object | null

Mapping for the alt text of media in the post

approval_policy
enum<string>

The approval policy of the approval request

Available options:
APPROVAL_REQUIRED,
APPROVAL_NOT_REQUIRED
approval_requests
object[]

The list of approval requests associated with the post.

auto_publish
boolean

Whether the post should be auto published.

board_ids
integer[]

The list of the board ids associated with the post.

Required range: x >= 0
callback_socket_id
string

Used to update the post in the DH user interface.

campaign_ids
integer[]

The list of the campaign ids associated with the post.

Required range: x >= 0
caption
string

Text content of the post.

collaborators
object[]

List of collaborators to be auto published with the post.

content_tag_ids
integer[]

The list of the content tag ids associated with the post.

Required range: x >= 0
cover_image_media_id
integer | null

The ID of the media which will be published as a Reel cover image.

creation_source
enum<string>

To identify the user or the application that created the post.

Available options:
RSS_FEED
duplicate_to_brand_ids
integer[]
write-only

The list of duplicate to brand ids.

Maximum array length: 55
Required range: x >= 0
first_comment
string

The first comment to be auto published for the post.

location_id
string | null

Facebook ID of the location tagged in the post

media_ids
integer[]

The list of the media ids attached to the post.

Required range: x >= 0
post_group_id
string<uuid>

The id of the post group associated with the post.

share_to_feed
boolean | null

Whether a Reel should be published to the Instagram Feed.

shopping_tags
object[]

List of shopping tags to be auto published with the post.

sort_index
number

The sorted index for unscheduled posts.

status
enum<string>

The current status of the post.

Available options:
AUTOPUBLISHING,
DRAFT,
EXPIRED,
FAILED,
IMPORTED,
MISSING_APPROVALS,
PARTIALLY_FAILED,
POSTED,
SCHEDULED,
SKIPPED,
USERS_NOTIFIED
story_link
string<url> | null

Link to be added to the post when publishing natively.

thumb_offset
integer | null

Location in milliseconds of the video frame to be used as the published cover thumbnail image.

thumbnail_url
string<url> | null

Image URL to be displayed as a thumbnail in the DH user interface.

timestamp
string<date-time> | null

The scheduled date & time for publishing the post.

user_tags
object[]

Array of public usernames and x/y coordinates for any public Instagram users to be tagged in an image.

Response

OK

post_type
enum<string>
required

Type of Instagram Post to be published.

Available options:
FEED,
STORY,
REEL
brand_id
integer

The id of the brand to which the post belongs.

Required range: x >= 0
auto_publish
boolean

Whether the post should be auto published.

status
enum<string>

The current status of the post.

Available options:
AUTOPUBLISHING,
DRAFT,
EXPIRED,
FAILED,
IMPORTED,
MISSING_APPROVALS,
PARTIALLY_FAILED,
POSTED,
SCHEDULED,
SKIPPED,
USERS_NOTIFIED
caption
string

Text content of the post.

media_ids
integer[]

The list of the media ids attached to the post.

Required range: x >= 0
timestamp
string<date-time> | null

The scheduled date & time for publishing the post.

first_comment
string

The first comment to be auto published for the post.

story_link
string<url> | null

Link to be added to the post when publishing natively.

share_to_feed
boolean | null

Whether a Reel should be published to the Instagram Feed.

user_tags
object[]

Array of public usernames and x/y coordinates for any public Instagram users to be tagged in an image.

collaborators
object[]

List of collaborators to be auto published with the post.

cover_image_media_id
integer | null

The ID of the media which will be published as a Reel cover image.

location_id
string | null

Facebook ID of the location tagged in the post

alt_text_media_map
object | null

Mapping for the alt text of media in the post

approval_policy
enum<string>

The approval policy of the approval request

Available options:
APPROVAL_REQUIRED,
APPROVAL_NOT_REQUIRED
approval_requests
object[]

The list of approval requests associated with the post.

approval_status
string
read-only

The approval status of the post.

auto_publish_error
enum<string>
read-only
Available options:
ACCOUNT_RESTRICTED,
AGAINST_COMMUNITY_STANDARDS,
APPROVED_PUBLISHING_DATES_HAVE_NO_OVERLAP,
AUTO_PUBLISH_LIMIT_EXCEEDED,
DUPLICATE_POST,
FLAGGED_AS_SPAM,
INTERNAL,
INVALID_ACCOUNT_TYPE,
INVALID_AUTH,
INVALID_DESCRIPTION,
INVALID_IMAGE,
INVALID_PIN_BOARD,
INVALID_PRODUCT_TAGS,
INVALID_TARGETING,
INVALID_TITLE,
INVALID_VIDEO_THUMBNAIL,
MEDIA_CONTAINER_EXPIRED,
MISSING_AUTH,
OUTSIDE_OF_APPROVED_PUBLISHING_DATES,
PAGE_PUBLISHING_AUTH_REQUIRED,
PLATFORM_ERROR,
REJECTED,
TEXT_LENGTH_EXCEEDED
board_ids
integer[]

The list of the board ids associated with the post.

Required range: x >= 0
callback_socket_id
string

Used to update the post in the DH user interface.

campaign_ids
integer[]

The list of the campaign ids associated with the post.

Required range: x >= 0
content_tag_ids
integer[]

The list of the content tag ids associated with the post.

Required range: x >= 0
cover_image_media
object
read-only

The media to be published as a Reel cover image.

created_at
string<date-time>
read-only

The time when the post was created.

creation_source
enum<string>

To identify the user or the application that created the post.

Available options:
RSS_FEED
first_comment_status
enum<string>
read-only
Available options:
SUCCESS,
FAILED
has_invalid_product_tags
boolean
read-only

Identifies a post that was unable to be published with product tags.

has_scheduled_time
boolean
read-only

Indicates if the post has a scheduled timestamp

id
integer
read-only

A unique id for the post.

Required range: x >= 0
invalid_collaborators
string[]
read-only

Collaborators that failed to be auto published with the post.

invalid_location
object

Location that failed to be auto published with the post.

invalid_user_tags
string[]
read-only

User tags that failed to be auto published with the post.

live_post_url
string<url>
read-only

Link to the live published post.

location
object

Location data fetched from Meta API by location_id

media
object[]
read-only

The list of media attached to the post.

num_of_approvals_required
integer
read-only

The number of approvals required to approve the request.

post_group_id
string<uuid>

The id of the post group associated with the post.

shopping_tags
object[]

List of shopping tags to be auto published with the post.

sort_index
number

The sorted index for unscheduled posts.

source_id
string | null
read-only
thumb_offset
integer | null

Location in milliseconds of the video frame to be used as the published cover thumbnail image.

thumbnail_url
string<url> | null

Image URL to be displayed as a thumbnail in the DH user interface.

updated_at
string<date-time>
read-only

The time when the post was last updated.