Graph API Version

Video

Represents an individual video on Facebook.

Reading

A Video

Permissions

  • Any valid access token can read videos on a public Page.
  • A page access token can read all videos posted to or posted by that Page.
  • A user access token can read any video your application created on behalf of that user.
  • A user's videos can be read if the owner has granted the user_videos or user_posts permission.
  • A user access token may read a video that user is tagged in if they user granted the user_videos or user_posts permission. However, in some cases the video's owner's privacy settings may not allow your application to access it.

Examples

Graph API Explorer
GET /v2.7/{video-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{video-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{video-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{video-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{video-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

backdated_time_granularity

enum

Accuracy of the backdated time.

content_category

enum

The content category of this video.

created_time

datetime

The time the video was initially published.

description

string

The description of the video.

embed_html

string

The HTML element that may be embedded in a Web page to play the video.

id

numeric string

The video ID.

backdated_time

datetime

The time when the video post was created.

content_tags

list<numeric string>

Tags that describe the contents of the video.

embeddable

bool

Whether the video is embeddable.

event

Event

If this object has a place, the event associated with the place

format

The different formats of the video.

from

The profile that created the video.

icon

string

The icon that Facebook displays when videos are published to the feed.

is_crossposting_eligible

bool

Specifies if the video is eligible for crossposting.

is_instagram_eligible

bool

Whether the video is eligible to be promoted on Instagram

length

float

Duration of this video.

live_status

enum

The live status of the video

permalink_url

string

URL to the permalink page of the video.

picture

string

The URL for the thumbnail picture of the video.

place

Place

Location associated with the video, if any.

privacy

Privacy

Privacy setting for the video.

published

bool

Whether a post about this video is published.

scheduled_publish_time

datetime

The time that the video is scheduled to publish.

source

string

A URL to the raw, playable video file.

status

VideoStatus

Object describing the status attributes of a video.

title

string

The video title or caption.

updated_time

datetime

The last time the video or its caption was updated.

Edges

EdgeDescription

auto_generated_captions

Auto-generated Captions from automated speech recognition system.

captions

Captions for the video.

comments

Users comments for the video.

likes

People who like this

reactions

People who reacted on this

sharedposts

Posts that share this video.

sponsor_tags

Sponsor pages tagged in the video.

tags

Users tagged in the video.

thumbnails

Thumbnails for the video.

video_insights

Total insights from all video posts associated with this video.

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can publish videos by using the following edges:

When including a source parameter, you should include a filename with the correct extension that indicates the type of file container. For example, the attached file name should be filename.mov instead of just filename. See the Video Upload with Graph API document for the list of supported container types.

Resumable Upload

In Graph API 2.3+ you can perform resumable upload of video chunks at the following edges:

For information, see the tutorial at Video Upload with Graph API.


You can make a POST request to advideos edge from the following paths:
When posting to this edge, a Video will be created.

Parameters

NameDescription
composer_session_id
string

composer session id

description
UTF-8 string

description

Supports Emoji
file_size
unsigned int32

The size of the video file in bytes. Using during chunked upload.

file_url
string

file url

is_explicit_share
boolean

is explicit share

manual_privacy
boolean
Default value: false

manual privacy

name
string

The name of the video in the library.

og_action_type_id
numeric string or integer

og action type id

og_icon_id
numeric string or integer

og icon id

og_object_id
OG object ID or URL string

og object id

og_phrase
string

og phrase

og_suggestion_mechanism
string

og suggestion mechanism

referenced_sticker_id
numeric string or integer

referenced sticker id

slideshow_spec
JSON object

An object required for slideshow video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

Required
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

source
string

The video, encoded as form data. See the Video Format doc for more details on video formats.

start_offset
unsigned int32

The start position in byte of the chunk that is being sent, inclusive. Used during chunked upload.

time_since_original_post
unsigned int32

time since original post

title
UTF-8 string

The name of the video being uploaded.

Supports Emoji
unpublished_content_type
enum {SCHEDULED, DRAFT, ADS_POST}

unpublished content type

upload_phase
enum {start, transfer, finish, cancel}

The phase during chunked upload. Using during chunked upload.

upload_session_id
numeric string or integer

The session ID of this chunked upload. Using during chunked upload.

video_file_chunk
string

The chunk of the video, between start_offset and end_offset. Using during chunked upload.

Return Type

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
}
You can make a POST request to videos edge from the following paths:
When posting to this edge, a Video will be created.

Parameters

NameDescription
backdated_post
array

Settings to allow backdated video post.A backdated post needs to be published.

backdated_time
datetime

The time when the video post was created.

Required
backdated_time_granularity
enum{year, month, day, hour, min, none}
Default value: none

Accuracy of the backdated time.

hide_from_newsfeed
boolean
Default value: false

Whether to hide the video from newsfeed display.

content_category
enum {BEAUTY_FASHION, BUSINESS, CARS_TRUCKS, COMEDY, CUTE_ANIMALS, ENTERTAINMENT, FAMILY, FOOD_HEALTH, HOME, LIFESTYLE, MUSIC, NEWS, POLITICS, SCIENCE, SPORTS, TECHNOLOGY, VIDEO_GAMING, OTHER}

Content category of this video.

content_tags
list<numeric string>

Tags that describe the contents of the video. Use search endpoint with type=adinterest to get possible IDs.

Example:

/search?type=adinterest&q=couscous
crossposted_video_id
numeric string or integer

The video id that the new video post will be reusing

description
UTF-8 string

The description of the video, used as the accompanying status message in any feed story. This parameter can contain mentions of other Facebook Pages using the following syntax:

@[page-id]

For example the following description would mention the Facebook Developers page inline:

Test message @[19292868552] tag

Usage of this feature is subject to review but by using Pages you are an admin of (both to make the API call, and to be used in a mention), and an app you are a developer of, you can test it for yourself before review.

Supports Emoji
embeddable
boolean

Whether the video is embeddable.

expiration
Object

Time the video expires and whether it will be removed or hidden.

time
string
type
enum{expire_and_delete, expire_only}
feed_targeting
feed target

Object that controls news feed targeting for this content. Anyone in these demographics will be more likely to see this content, those not will be less likely, but may still see it anyway. Any of the targeting fields shown here can be used, none are required.

countries
list<string>

Values for targeted countries. You can specify up to 25 countries. Use ISO 3166 format codes.

regions
list<Object>

Values for targeted regions. Use type of adregion to find Targeting Options and use the returned key to specify. For example:

search/?type=adregion&q=California
key
unsigned int32
cities
list<Object>

Values for targeted cities. Use type of adcity to find Targeting Options and use the returned key to specify.

key
unsigned int32
zipcodes
list<Object>
key
string
locales
list<string>

Values for targeted locales. Use type of adlocale to find Targeting Options and use the returned key to specify.

age_min
unsigned int32

Must be 13 or higher. Default is 0.

age_max
unsigned int32

Maximum age.

genders
list<unsigned int32>

Target specific genders. 1 targets all male viewers and 2 females. Default is to target both.

college_years
list<unsigned int32>

Array of integers. Represent graduation years from college.

education_statuses
list<unsigned int32>

Array of integers which represent current educational status. Use 1 for high school, 2 for undergraduate, and 3 for alum (or localized equivalents).

interested_in
list<unsigned int32>

Indicates targeting based on the 'interested in' field of the user profile. You can specify an integer of 1 to indicate male, 2 indicates female. Default is all types. Please note 'interested in' targeting is not available in France due to local laws.

relationship_statuses
list<unsigned int32>

Array of integers for targeting based on relationship status. Use 1 for single, 2 for 'in a relationship', 3 for married, and 4 for engaged. Default is all types.

interests
list<unsigned int32>

One or more IDs of pages to target fans of pages.Use type of page to get possible IDs as find Targeting Options and use the returned id to specify.

relevant_until
unsigned int32

Specify time when story becomes irrelevant to show.

file_size
unsigned int32

The size of the entire video file in bytes.

file_url
string

Accessible URL of a video file. Cannot be used with upload_phase.

no_story
boolean

If set to true, this will suppress feed and timeline story.

published
boolean
Default value: true

Whether a post about this video is published. Non-published videos cannot be backdated.

referenced_sticker_id
numeric string or integer

Sticker id of the sticker in the post

scheduled_publish_time
unsigned int32

Time when the page post about this video should go live, this should be between 10 mins and 6 months from the time of publishing the video.

secret
boolean

If set to true, this video will not appear anywhere on Facebook and is not searchable. It can be viewed and shared using permalink and embeds. Default value is false.

slideshow_spec
JSON object

Specification of a list of images that are used to generate video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

Required
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

social_actions
boolean

This can be used to enable or prohibit the use of Facebook socialactions (likes, comments, and sharing) on an unlisted video. Default value is false

source
string

The video, encoded as form data. This field is required.

sponsor_id
numeric string or integer

Facebook Page id that is tagged as sponsor in the video post

start_offset
unsigned int32

Start byte position of the file chunk.

targeting
target

Object that limits the audience for this content. Anyone not in these demographics will not be able to view this content. This will not override any Page-level demographic restrictions that may be in place.

countries
list<string>

Values for targeted countries. You can specify up to 25 countries. Use ISO 3166 format codes.

regions
list<Object>

Values for targeted regions. Use type of adregion to find Targeting Options and use the returned key to specify. For example:

search/?type=adregion&q=California
key
unsigned int32
cities
list<Object>

Values for targeted cities. Use type of adcity to find Targeting Options and use the returned key to specify.

key
unsigned int32
zipcodes
list<string>

Values for targeted zipcodes. Use type of adzipcode to find Targeting Options and use the returned key to specify.

locales
list<string>

Values for targeted locales. Use type of adlocale to find Targeting Options and use the returned key to specify.

excluded_countries
list<string>

Values for excluded countries. You can specify up to 25 countries. Use ISO 3166 format codes.

excluded_regions
list<unsigned int32>

Values for excluded regions. Use type of adregion and list of GLOBAL to find Targeting Options and use the returned key to specify. For example:

search/?type=adregion&q=California&list=GLOBAL
excluded_cities
list<unsigned int32>

Values for excluded cities. Use type of adcity to find Targeting Options and use the returned key to specify.

excluded_zipcodes
list<string>

Values for excluded zipcodes. Use type of adzipcode to find Targeting Options and use the returned key to specify.

excluded_locales
list<string>
timezones
list<unsigned int32>

ID for the timezone. See here.

age_min
unsigned int32

Must be 13 or higher. Default is 0.

age_max
unsigned int32

Maximum age.

genders
list<unsigned int32>

Target specific genders. 1 targets all male viewers and 2 females. Default is to target both.

thumb
image

The video thumbnail raw data to be uploaded and associated with a video.

title
UTF-8 string

The title of the video.

Supports Emoji
unpublished_content_type
enum {SCHEDULED, DRAFT, ADS_POST}

Type of unpublished content, such as scheduled, draft or ads_post.

upload_phase
enum {start, transfer, finish, cancel}

Type of chunked upload request.

upload_session_id
numeric string or integer

ID of the chunked upload session.

video_file_chunk
string

The video file chunk, encoded as form data. This field is required during transfer upload phase.

Return Type

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
}
You can make a POST request to videos edge from the following paths:
When posting to this edge, a Video will be created.

Parameters

NameDescription
content_category
enum {BEAUTY_FASHION, BUSINESS, CARS_TRUCKS, COMEDY, CUTE_ANIMALS, ENTERTAINMENT, FAMILY, FOOD_HEALTH, HOME, LIFESTYLE, MUSIC, NEWS, POLITICS, SCIENCE, SPORTS, TECHNOLOGY, VIDEO_GAMING, OTHER}

Content category of this video.

description
UTF-8 string

The description of the video, used as the accompanying status message in any feed story. This parameter can contain mentions of other Facebook Pages using the following syntax:

@[page-id]

For example the following description would mention the Facebook Developers page inline:

Test message @[19292868552] tag

Usage of this feature is subject to review but by using Pages you are an admin of (both to make the API call, and to be used in a mention), and an app you are a developer of, you can test it for yourself before review.

Supports Emoji
embeddable
boolean

Whether the video is embeddable.

file_size
unsigned int32

The size of the entire video file in bytes.

file_url
string

Accessible URL of a video file. Cannot be used with upload_phase.

no_story
boolean
Default value: false

If set to true, this will suppress feed and timeline story.

privacy
Privacy Parameter

Determines the privacy settings of the video. If not supplied, this defaults to the privacy level granted to the app in the Login Dialog. This field cannot be used to set a more open privacy setting than the one granted.

referenced_sticker_id
numeric string or integer

Sticker id of the sticker in the post

slideshow_spec
JSON object

Specification of a list of images that are used to generate video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

Required
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

source
string

The video, encoded as form data. This field is required.

sponsor_id
numeric string or integer

Facebook Page id that is tagged as sponsor in the video post

start_offset
unsigned int32

Start byte position of the file chunk.

thumb
image

The video thumbnail raw data to be uploaded and associated with a video.

title
UTF-8 string

The title of the video.

Supports Emoji
unpublished_content_type
enum {SCHEDULED, DRAFT, ADS_POST}

Type of unpublished content, such as scheduled, draft or ads_post.

upload_phase
enum {start, transfer, finish, cancel}

Type of chunked upload request.

upload_session_id
numeric string or integer

ID of the chunked upload session.

video_file_chunk
string

The video file chunk, encoded as form data. This field is required during transfer upload phase.

Return Type

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
}
You can make a POST request to videos edge from the following paths:
When posting to this edge, a Video will be created.

Parameters

NameDescription
content_category
enum {BEAUTY_FASHION, BUSINESS, CARS_TRUCKS, COMEDY, CUTE_ANIMALS, ENTERTAINMENT, FAMILY, FOOD_HEALTH, HOME, LIFESTYLE, MUSIC, NEWS, POLITICS, SCIENCE, SPORTS, TECHNOLOGY, VIDEO_GAMING, OTHER}

Content category of this video.

description
UTF-8 string

The description of the video, used as the accompanying status message in any feed story. This parameter can contain mentions of other Facebook Pages using the following syntax:

@[page-id]

For example the following description would mention the Facebook Developers page inline:

Test message @[19292868552] tag

Usage of this feature is subject to review but by using Pages you are an admin of (both to make the API call, and to be used in a mention), and an app you are a developer of, you can test it for yourself before review.

Supports Emoji
embeddable
boolean

Whether the video is embeddable.

file_size
unsigned int32

The size of the entire video file in bytes.

file_url
string

Accessible URL of a video file. Cannot be used with upload_phase.

referenced_sticker_id
numeric string or integer

Sticker id of the sticker in the post

slideshow_spec
JSON object

Specification of a list of images that are used to generate video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

Required
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

source
string

The video, encoded as form data. This field is required.

start_offset
unsigned int32

Start byte position of the file chunk.

thumb
image

The video thumbnail raw data to be uploaded and associated with a video.

title
UTF-8 string

The title of the video.

Supports Emoji
unpublished_content_type
enum {SCHEDULED, DRAFT, ADS_POST}

Type of unpublished content, such as scheduled, draft or ads_post.

upload_phase
enum {start, transfer, finish, cancel}

Type of chunked upload request.

upload_session_id
numeric string or integer

ID of the chunked upload session.

video_file_chunk
string

The video file chunk, encoded as form data. This field is required during transfer upload phase.

Return Type

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
}
You can make a POST request to videos edge from the following paths:
When posting to this edge, a Video will be created.

Parameters

NameDescription
content_category
enum {BEAUTY_FASHION, BUSINESS, CARS_TRUCKS, COMEDY, CUTE_ANIMALS, ENTERTAINMENT, FAMILY, FOOD_HEALTH, HOME, LIFESTYLE, MUSIC, NEWS, POLITICS, SCIENCE, SPORTS, TECHNOLOGY, VIDEO_GAMING, OTHER}

Content category of this video.

description
UTF-8 string

The description of the video, used as the accompanying status message in any feed story. This parameter can contain mentions of other Facebook Pages using the following syntax:

@[page-id]

For example the following description would mention the Facebook Developers page inline:

Test message @[19292868552] tag

Usage of this feature is subject to review but by using Pages you are an admin of (both to make the API call, and to be used in a mention), and an app you are a developer of, you can test it for yourself before review.

Supports Emoji
embeddable
boolean

Whether the video is embeddable.

file_size
unsigned int32

The size of the entire video file in bytes.

file_url
string

Accessible URL of a video file. Cannot be used with upload_phase.

referenced_sticker_id
numeric string or integer

Sticker id of the sticker in the post

slideshow_spec
JSON object

Specification of a list of images that are used to generate video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

Required
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

source
string

The video, encoded as form data. This field is required.

start_offset
unsigned int32

Start byte position of the file chunk.

thumb
image

The video thumbnail raw data to be uploaded and associated with a video.

title
UTF-8 string

The title of the video.

Supports Emoji
unpublished_content_type
enum {SCHEDULED, DRAFT, ADS_POST}

Type of unpublished content, such as scheduled, draft or ads_post.

upload_phase
enum {start, transfer, finish, cancel}

Type of chunked upload request.

upload_session_id
numeric string or integer

ID of the chunked upload session.

video_file_chunk
string

The video file chunk, encoded as form data. This field is required during transfer upload phase.

Return Type

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
}
You can make a POST request to videos edge from the following paths:
When posting to this edge, a Video will be created.

Parameters

NameDescription
content_category
enum {BEAUTY_FASHION, BUSINESS, CARS_TRUCKS, COMEDY, CUTE_ANIMALS, ENTERTAINMENT, FAMILY, FOOD_HEALTH, HOME, LIFESTYLE, MUSIC, NEWS, POLITICS, SCIENCE, SPORTS, TECHNOLOGY, VIDEO_GAMING, OTHER}

Content category of this video.

description
UTF-8 string

The description of the video, used as the accompanying status message in any feed story. This parameter can contain mentions of other Facebook Pages using the following syntax:

@[page-id]

For example the following description would mention the Facebook Developers page inline:

Test message @[19292868552] tag

Usage of this feature is subject to review but by using Pages you are an admin of (both to make the API call, and to be used in a mention), and an app you are a developer of, you can test it for yourself before review.

Supports Emoji
embeddable
boolean

Whether the video is embeddable.

file_size
unsigned int32

The size of the entire video file in bytes.

file_url
string

Accessible URL of a video file. Cannot be used with upload_phase.

referenced_sticker_id
numeric string or integer

Sticker id of the sticker in the post

slideshow_spec
JSON object

Specification of a list of images that are used to generate video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

Required
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

source
string

The video, encoded as form data. This field is required.

start_offset
unsigned int32

Start byte position of the file chunk.

thumb
image

The video thumbnail raw data to be uploaded and associated with a video.

title
UTF-8 string

The title of the video.

Supports Emoji
unpublished_content_type
enum {SCHEDULED, DRAFT, ADS_POST}

Type of unpublished content, such as scheduled, draft or ads_post.

upload_phase
enum {start, transfer, finish, cancel}

Type of chunked upload request.

upload_session_id
numeric string or integer

ID of the chunked upload session.

video_file_chunk
string

The video file chunk, encoded as form data. This field is required during transfer upload phase.

Return Type

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
}
You may perform a POST request to the following edges from this node:

Validation Rules

ErrorDescription
100Invalid parameter
210User not visible
475Due to activity related to copyright infringement on your Facebook account, we have disabled your ability to upload any further videos.
114Invalid user id list

Updating

Permissions

Your app needs an user access token with publish_actions permission to update a video.


You can update a Video by making a POST request to /{video_id}.

Parameters

NameDescription
allow_bm_crossposting
boolean

If set to true, Pages under your Business Manager will be able to crosspost the video.

backdated_time
datetime

The time when the video post was created. A backdated post needs to be published.

backdated_time_granularity
enum{year, month, day, hour, min, none}
Default value: none

Accuracy of the backdated time. A backdated post needs to be published.

content_category
enum {BEAUTY_FASHION, BUSINESS, CARS_TRUCKS, COMEDY, CUTE_ANIMALS, ENTERTAINMENT, FAMILY, FOOD_HEALTH, HOME, LIFESTYLE, MUSIC, NEWS, POLITICS, SCIENCE, SPORTS, TECHNOLOGY, VIDEO_GAMING, OTHER}

The content category of this video.

content_tags
list<numeric string>

Tags that describe the contents of the video. Use search endpoint with type=adinterest to get possible IDs.

Example:

/search?type=adinterest&q=couscous
description
UTF-8 string

Description of the video.

Supports Emoji
embeddable
boolean

Whether the video is embeddable.

expiration
Object

Time the video expires and whether it will be removed or hidden.

time
string
type
enum{expire_and_delete, expire_only}
expire_now
boolean

If set to true, the video will expire now.

name
UTF-8 string

Video title or caption.

Supports Emoji
place
place tag

Location associated with the video, if any.

preferred_thumbnail_id
numeric string

Preferred thumbnail image ID

publish_to_news_feed
boolean

Distributes video item publicly to News Feed, Page Timeline, and Page Videos tab.

publish_to_videos_tab
boolean

Distributes video item publicly to the Page's Videos tab, but not News Feed or Timeline

scheduled_publish_time
unsigned int32

Scheduled publish time for the video.

social_actions
boolean

Whether the video has likes, comments and shares disabled.

sponsor_id
numeric string or integer

Facebook Page id that is tagged as sponsor in the video post

tags
list<numeric string>

Users tagged in the video.

Return Type

Struct {
success: bool,
}
You may perform a POST request to the following edge from this node:

Validation Rules

ErrorDescription
100Invalid parameter
210User not visible
475Due to activity related to copyright infringement on your Facebook account, we have disabled your ability to upload any further videos.
114Invalid user id list

Deleting

Permissions

To delete a user video, a user access token with publish_actions is required.

To delete a page video, a page access token with publish_actions is required.

Your app needs an user access token with publish_actions permission to delete a video.

Example

https://graph.facebook.com/<video_id>
You can dissociate a Video from a Page by making a DELETE request to /{page_id}/featured_videos_collection.

Parameters

NameDescription
video_id
numeric string or integer

ID of the video to be unfeatured from the Page.

Required

Return Type

Struct {
success: bool,
}
You can delete a Video by making a DELETE request to /{video_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}
You may perform a DELETE request to the following edge from this node:

Validation Rules

ErrorDescription
100Invalid parameter