POST /2/media/metadata

MetadataCreate

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String Yes

The unique identifier of this Media.

metadata Object No
metadata.content_expiration Object No
metadata.content_expiration.timestamp_sec Number No

Expiration time for content as a Unix timestamp in seconds

metadata.audience_policy Object No
metadata.audience_policy.x_subscriptions[] Array No
metadata.audience_policy.creator_subscriptions[] Array No
metadata.sticker_info Object No
metadata.sticker_info.stickers[] Array No

Stickers list must not be empty and should not exceed 25

metadata.sticker_info.stickers[].id String No

Unique identifier for sticker

metadata.sticker_info.stickers[].sticker_set_annotation_id Number No

A unique identifier for the sticker set associated with the media

metadata.sticker_info.stickers[].transform_a Number No

Scale or rotate the media on the x-axis

metadata.sticker_info.stickers[].transform_c Number No

Skew the media on the y-axis

metadata.sticker_info.stickers[].transform_tx Number No

Scale or rotate the media on the x-axis

metadata.sticker_info.stickers[].transform_b Number No

Skew the media on the x-axis

metadata.sticker_info.stickers[].transform_ty Number No

The vertical translation (shift) value for the media

metadata.sticker_info.stickers[].transform_d Number No

Scale or rotate the media on the y-axis

metadata.sticker_info.stickers[].aspect_ratio Number No

width-to-height ratio of the media

metadata.sticker_info.stickers[].group_annotation_id Number No

A unique identifier for the group of annotations associated with the media

metadata.management_info Object No
metadata.management_info.managed Boolean No

Indicates if the media is managed by Media Studio

metadata.found_media_origin Object No
metadata.found_media_origin.id String No

Unique Identifier of media within provider ( <= 24 characters ))

metadata.found_media_origin.provider String No

The media provider (e.g., 'giphy') that sourced the media ( <= 8 Characters )

metadata.alt_text Object No
metadata.alt_text.text String No

Description of media ( <= 1000 characters )

metadata.allow_download_status Object No
metadata.allow_download_status.allow_download Boolean No
metadata.shared_info Object No
metadata.shared_info.shared Boolean No

Indicates if the media is shared in direct messages

metadata.geo_restrictions No
metadata.domain_restrictions Object No
metadata.domain_restrictions.whitelist[] Array No

List of whitelisted domains

metadata.preview_image Object No
metadata.preview_image.media_key Object No
metadata.preview_image.media_key.media_category String No

The media category of media

Possible values:

  • "TweetImage"

Default value: "TweetImage"

metadata.preview_image.media_key.media String No

The unique identifier of this Media.

metadata.sensitive_media_warning Object No
metadata.sensitive_media_warning.other Boolean No

Indicates if the content has other sensitive characteristics

metadata.sensitive_media_warning.adult_content Boolean No

Indicates if the content contains adult material

metadata.sensitive_media_warning.graphic_violence Boolean No

Indicates if the content depicts graphic violence

metadata.upload_source Object No
metadata.upload_source.upload_source String No

Records the source (e.g., app, device) from which the media was uploaded

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.