Skip to main content
POST
Create post

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Body

application/json

One post to one connected account. Copy uses the same fields for every platform; see the operation description for which fields each platform uses and their limits.

platform
enum<string>
required

Target platform. The account must have this platform connected.

Available options:
instagram,
x,
linkedin,
youtube
video_url
string<uri>
required

Publicly reachable URL of the video file (MP4). It is fetched at publish time, so it must still resolve then.

account_id
string<uuid>

Optional. The account whose connection posts (e.g. an artist). The authenticated account must have access. Defaults to the calling account.

sub_account_id
string

Optional, LinkedIn only. Organization URN to post as a Page (e.g. urn:li:organization:101127186) instead of as the connected member. The connected member must be an admin of that Page.

cover_url
string<uri>

Optional. Publicly reachable image URL used as the cover or thumbnail where the platform supports one (see the table in the description).

title
string

Title. Required for youtube; see the table in the description.

description
string

Body text: caption, post text or description, depending on the platform. Required for instagram, x and linkedin.

privacy
enum<string>
default:public

Optional, YouTube only. Visibility after upload.

Available options:
public,
unlisted,
private
tags
string[]

Optional, YouTube only. Video tags.

publish_at
string<date-time>

Optional. ISO 8601 time to publish, in the future. Omit to publish now.

Response

Post accepted: publishing now, or scheduled for publish_at.

The post's id and current status.

id
string<uuid>
required

The post's id. Poll Get Post with this.

status
enum<string>
required

Lifecycle phase. scheduled until publish_at, publishing while the platform upload runs, then posted or failed. cancelled only from scheduled.

Available options:
scheduled,
publishing,
posted,
failed,
cancelled