Skip to main content
PATCH
Update post

Authorizations

X-API-Key
string
header
required

Path Parameters

postId
string
required

Ocoya post ID.

Example:

"cmajvvb9q0003ja5vh0538j6r"

Body

application/json
caption
string

New caption to apply to existing post variations.

Example:

"Launching our summer campaign today."

scheduledAt
string | null

ISO 8601 datetime when the post should be scheduled, or null to make it unscheduled.

Example:

"2024-01-01T00:00:00Z"

publishNow
boolean

Publish the existing post immediately without creating a new post.

Example:

true

brandId
string | null

Brand kit ID to apply, or null to remove the brand kit.

Example:

"cmayw7l5200067apsmz2tv7e8"

mediaUrls
string[]

Full replacement set of publicly reachable image or video URLs. Maximum 5. Use an empty array to remove all media.

Example:
addMediaUrls
string[]

Publicly reachable image or video URLs to add without removing existing media. Maximum 5 total.

Example:
clearMedia
boolean

Remove all media from the post. Ignored when mediaUrls is provided.

Example:

false

socialProfileIds
string[]

Full replacement set of connected social profile IDs that should receive the post. Get IDs from GET /social-profiles.

Example:
addSocialProfileIds
string[]

Connected social profile IDs to add without removing profiles already attached to the post.

Example:

Response

Success