Skip to main content
PATCH
Update submission metadata

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
required

Response

Successful response

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

Platform identifier. Known value: instagram.

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

Known values: short_video, video, image, carousel, text.

account
object
required
posted_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
status
enum<string>
required
Available options:
active,
paused,
unavailable,
parked,
stopped
next_read_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
unavailable_reason
string | null
required

Known values: post_not_found, token_invalid, no_linked_account, connection_removed.

parked_reason
string | null
required

Known values: token_invalid, read_failed.

metadata
object
required
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
latest
object