Skip to main content
PATCH
Update a submission

Authorizations

Authorization
string
header
required

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

Path Parameters

submission_id
string
required

Submission ID. Format: sub_ followed by 24 lowercase hexadecimal characters.

Example:

"sub_0899bdcb659c102e360005ec"

Body

application/json
metadata
object | null
cadence_hours
enum<number>

How often to read each media, in hours: 1, 2, 3, 4, 6, 8 or 12. A faster cadence costs fewer credits per read and more per day. The default is the project's cadence.

Available options:
1,
2,
3,
4,
6,
8,
12
end_at
string<date-time> | null

A new end date, or null to remove it. It must be in the future.

geo
boolean

Set to true to turn geo on. Instagram and YouTube only. Set to false to turn it off before the first read. After the first read, false answers 409.

Response

Successful response

id
string
required
Pattern: ^sub_[0-9a-f]{24}$
platform
string
required

Platform identifier. Known values: instagram, x, youtube.

url
string<uri>
required
platform_media_id
string
required
media_type
string | null
required

Known values: short_video, video, image, carousel, text. On YouTube, short_video means 180 seconds or less and video means longer than 180 seconds.

account
object
required
posted_at
string<date-time> | null
required
status
enum<string>
required
Available options:
active,
paused,
unavailable,
parked,
stopped
next_read_at
string<date-time> | null
required
unavailable_reason
string | null
required

Known values: post_not_found, posted_before_professional, token_invalid, no_linked_account, connection_removed.

parked_reason
string | null
required

Known values: token_invalid, insights_permission_missing, account_not_professional, read_failed.

metadata
object
required
cadence_hours
integer
required

How often this media is read, in hours.

Required range: -9007199254740991 <= x <= 9007199254740991
start_at
string<date-time> | null
required

When tracking starts. Null means it started at create.

end_at
string<date-time> | null
required

When tracking ends. The media becomes stopped at this time. Null means no end date.

geo
boolean
required

True when audience data is collected for this media: its account's audience on Instagram, the media's own audience on YouTube. Instagram and YouTube only.

created_at
string<date-time>
required
latest
object