Graph API Version

User

Represents a Facebook user.

Reading

Gets a User.

Example

GET /v7.0/{person-id}/ HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{person-id}/',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/{person-id}/",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{person-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:@"/{person-id}/"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v7.0/{person-id}/

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

Field	Description
`id` numeric string	The ID of this person's user account. This ID is unique to each app and cannot be used across different apps. Our upgrade guide provides more information about app-specific IDs Core
`about` string	Returns no data as of April 4, 2018.
`access_code`app-workplace WorkAccessCode	The access code for a Workplace email-less account.
`account_claim_time`app-workplace datetime	The timestamp when the Workplace account was claimed.
`account_invite_time`app-workplace datetime	The timestamp when the Workplace account was invited.
`active`app-workplace bool	Whether this Workplace account is currently active.
`address` Location	The User's address.
`admin_notes` list<PageAdminNote>	Notes added by viewing page on this User.
`age_range` AgeRange	The age segment for this person expressed as a minimum and maximum age. For example, more than 18, less than 21. Core
`auth_method` enum	The authentication method a Workplace User has configured for their account. It can be either "password" or "sso".
`birthday` string	The person's birthday. This is a fixed format string, like `MM/DD/YYYY`. However, people can control who can see the year they were born separately from the month and day so this string can be only the year (YYYY) or the month + day (MM/DD) Core
`can_delete`app-workplace bool	Whether this Workplace user account can be deleted
`claim_link`app-workplace string	Url for claiming the workplace user account.
`community`app-workplace Group	The Workplace community this user belongs to.
`cost_center`app-workplace string	Cost center name of a Workplace user
`department`app-workplace string	Department name of a Workplace user
`devices` list<UserDevice>	The list of devices the person is using. This will return only iOS and Android devices Deprecated
`division`app-workplace string	Division name of a Workplace user
`education` list<EducationExperience>	Returns no data as of April 4, 2018.
`email` string	The User's primary email address listed on their profile. This field will not be returned if no valid email address is available. Core
`employee_number`app-workplace string	The User's employee number, as set by the company via SCIM API.
`external_id`app-workplace string	A company specified unique identifier of employee users within a company.
`favorite_athletes` list<Experience>	Athletes the User likes.
`favorite_teams` list<Experience>	Sports teams the User likes.
`first_name` string	The person's first name Core
`frontline`app-workplace WorkUserFrontline	Information about the frontline functionality related to this user
`gender` string	The gender selected by this person, `male` or `female`. If the gender is set to a custom value, this value will be based off of the preferred pronoun; it will be omitted if the preferred pronoun is neutral Core
`hometown` Page	The person's hometown
`impersonate_token`app-workplace string	The access token you can use to act as the person
`inspirational_people` list<Experience>	The person's inspirational people
`installed` bool	Is the app making the request installed
`interested_in` list<string>	Returns no data as of April 4, 2018.
`is_guest_user` bool	if the current user is a guest user. should always return false.
`is_shared_login` bool	Is this a shared login (e.g. a gray user)
`languages` list<Experience>	Facebook Pages representing the languages this person knows
`last_name` string	The person's last name Core
`link` string	A link to the person's Timeline. The link will only resolve if the person clicking the link is logged into Facebook and is a friend of the person whose profile is being viewed. Core
`local_news_megaphone_dismiss_status` bool	Display megaphone for local news bookmark Deprecated
`local_news_subscription_status` bool	Daily local news notification Deprecated
`locale` string	The person's locale CoreDeprecated
`location` Page	The person's current location as entered by them on their profile. This field requires the `user_location` permission. Core
`meeting_for` list<string>	What the person is interested in meeting for
`middle_name` string	The person's middle name Core
`name` string	The person's full name Core Default
`name_format` string	The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering
`organization`app-workplace string	Organization that the Workplace user belongs to
`political` string	Returns no data as of April 4, 2018.
`primary_address`app-workplace string	The primary address of a Workplace user
`primary_phone`app-workplace string	The primary phone number of a Workplace user
`profile_pic` string	The profile picture URL of the Messenger user. The URL will expire.
`public_key` string	The person's PGP public key
`quotes` string	The person's favorite quotes
`relationship_status` string	Returns no data as of April 4, 2018.
`religion` string	Returns no data as of April 4, 2018.
`security_settings` SecuritySettings	Security settings
`shared_login_upgrade_required_by` datetime	The time that the shared login needs to be upgraded to Business Manager by
`significant_other` User	The person's significant other
`sports` list<Experience>	Sports played by the person
`supports_donate_button_in_live_video` bool	Whether the user can add a Donate Button to their Live Videos
`term_date`app-workplace datetime	The date this Workplace user was terminated
`third_party_id` string	A string containing an anonymous, unique identifier for the User, for use with third-parties. Deprecated for versions 3.0+. Apps using older versions of the API can get this field until January 8, 2019. Apps installed by the User on or after May 1st, 2018, cannot get this field. Deprecated
`timezone` float (min: -24) (max: 24)	The person's current timezone offset from UTC CoreDeprecated
`title`app-workplace string	Job title of a Workplace user
`token_for_business` string	A token that is the same across a business's apps. Access to this token requires that the person be logged into your app or have a role on your app. This token will change if the business owning the app changes
`updated_time` datetime	Updated time Deprecated
`verified` bool	Indicates whether the account has been verified. This is distinct from the `is_verified` field. Someone is considered verified if they take any of the following actions: `* Register for mobile * Confirm their account via SMS * Enter a valid credit card` Deprecated
`video_upload_limits` VideoUploadLimits	Video upload limits
`website` string	Returns no data as of April 4, 2018.
`work` list<WorkExperience>	Returns no data as of April 4, 2018.
`work_locale`app-workplace string	Locale of a Workplace user

Edges

Edge	Description
`accounts`	Pages the User has a role on.
`ad_studies`	Ad studies that this User's can view.
`adaccounts`	The advertising accounts the User can access.
`albums`	The photo albums this person has created
`apprequestformerrecipients`	App requests
`apprequests`	This person's pending requests from an app Core
`assigned_ad_accounts`	Ad accounts that are assigned to this business scoped user
`assigned_business_asset_groups`	Business asset groups that are assign to this business scoped user
`assigned_pages`	Pages that are assigned to this business scoped user
`assigned_product_catalogs`	Product catalogs that are assigned to this business scoped user
`business_users`	Business users corresponding to the user
`businesses`	Businesses associated with the user
`cover` UserCoverPhoto	The person's cover photo Deprecated
`feed` Edge	The posts and links published by this person or others on their profile
`friendlists`	Returns no data as of April 4, 2018.
`friendrequests` Edge	The person's incoming friend requests
`friends`	The person's friends Core
`groups`	The Facebook Groups for which the person has given any group level permission
`ids_for_apps`	Businesses can claim ownership of multiple apps using Business Manager. This edge returns the list of IDs that this user has in any of those other apps
`ids_for_business`	Businesses can claim ownership of multiple apps using Business Manager. This edge returns the list of IDs that this user has in any of those other apps
`ids_for_pages`	Businesses can claim ownership of apps and pages using Business Manager. This edge returns the list of IDs that this user has in any of the pages owned by this business
`likes`	All the Pages this person has liked
`live_encoders`	Live encoders owned by this person
`live_videos`	Live videos from this person
`managed_groups`app-workplace	managed_groups
`managers`app-workplace	Managers of a Workplace user
`music`	Music this person likes
`notifications` Edge	Notifications for the person
`notify_me` Edge	This endpoint is removed as of Graph API version 2.0
`payments` Edge	Deprecated endpoint for Facebook Credits product. Use Facebook Payments instead
`permissions`	The permissions that the person has granted this app Core
`personal_ad_accounts`	The advertising accounts to which this person has personal access
`phones`app-workplace	The phone numbers of a Workplace user
`photos`	Photos the person is tagged in or has uploaded
`posts` Edge	This is similar to the `/feed`s edge but only shows posts published by the person themselves
`privacy_options` Edge	Privacy options
`reports`app-workplace	Reports of a Workplace user
`rich_media_documents`	A list of rich media documents belonging to Pages that the user has advertiser permissions on
`scores` Edge	The scores this person has received from Facebook Games that they've played Deprecated
`skills`app-workplace	The skills of a Workplace user
`taggable_friends`	Friends that can be tagged in content published via the Graph API
`videos`	Videos the person is tagged in or uploaded

Validation Rules

Error	Description
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token
80006	There have been too many messenger api calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
200	Permissions error
80001	There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
459	The session is invalid because the user has been checkpointed
613	Calls to this api have exceeded the rate limit.
452	Session key invalid. This could be because the session key has an incorrect format, or because the user has revoked this session
2635	You are calling a deprecated version of the Ads API. Please update to the latest version.
210	User not visible

Creating

You can't perform this operation on this endpoint.

Updating

You can update a User by making a POST request to /{user_id}.

Parameters

Parameter	Description
`emoji_color_pref` int64	emoji color preference.
`firstname` string	This person's first name
`lastname` string	This person's last name
`local_news_megaphone_dismiss_status` enum {YES, NO}	Dismisses local news megaphone
`local_news_subscription_status` enum {STATUS_ON, STATUS_OFF}	Preference for setting local news notifications
`name` string	Used for test accounts only. Name for this account
`password` string	Used for test accounts only. Password for this account

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

success: bool,

}

Validation Rules

Error	Description
100	Invalid parameter
200	Permissions error
240	Desktop applications cannot call this function for other users
459	The session is invalid because the user has been checkpointed
190	Invalid OAuth 2.0 Access Token
210	User not visible

You can update a User by making a POST request to /{user_id}/game_items.

Parameters

Parameter	Description
`action` enum {MARK, CONSUME, DROP}	Action to trigger on an inventory item Required
`app_id` application ID	Overrides the application from the user access token. Must be another app within the business
`drop_table_id` game_drop_table ID	What loot drop table to trigger for the DROP action
`ext_id` string	External id assigned by the game for the item
`item_id` game_item ID	What item id to target for the MARK and CONSUME actions
`quantity` int64	SELF_EXPLANATORY

Return Type

Struct {

id: unsigned integer,

count: unsigned integer,

created: timestamp,

item_def: string,

status: enum,

updated: timestamp,

ext_id: string,

}

Validation Rules

Error	Description
100	Invalid parameter

You can update a User by making a POST request to /{user_id}/force_password_reset.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {

success: bool,

}

Validation Rules

Error	Description
200	Permissions error
100	Invalid parameter

You can update a User by making a POST request to /{user_id}/logout.

Parameters

This endpoint doesn't have any parameters.

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

success: bool,

}

Validation Rules

Error	Description
100	Invalid parameter

You can update a User by making a POST request to /{custom_audience_id}/users.

Example

Graph API Explorer

POST /v7.0/<CUSTOM_AUDIENCE_ID>/users HTTP/1.1
Host: graph.facebook.com

payload=%7B%22schema%22%3A%5B%22EMAIL%22%2C%22LOOKALIKE_VALUE%22%5D%2C%22data%22%3A%5B%5B%229b431636bd164765d63c573c346708846af4f68fe3701a77a3bdd7e7e5166254%22%2C44.5%5D%2C%5B%228cc62c145cd0c6dc444168eaeb1b61b351f9b1809a579cc9b4c9e9d7213a39ee%22%2C140%5D%2C%5B%224eaf70b1f7a797962b9d2a533f122c8039012b31e0a52b34a426729319cb792a%22%2C0%5D%2C%5B%2298df8d46f118f8bef552b0ec0a3d729466a912577830212a844b73960777ac56%22%2C0.9%5D%5D%7D

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/<CUSTOM_AUDIENCE_ID>/users',
    array (
      'payload' => '{"schema":["EMAIL","LOOKALIKE_VALUE"],"data":[["9b431636bd164765d63c573c346708846af4f68fe3701a77a3bdd7e7e5166254",44.5],["8cc62c145cd0c6dc444168eaeb1b61b351f9b1809a579cc9b4c9e9d7213a39ee",140],["4eaf70b1f7a797962b9d2a533f122c8039012b31e0a52b34a426729319cb792a",0],["98df8d46f118f8bef552b0ec0a3d729466a912577830212a844b73960777ac56",0.9]]}',
    ),
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/<CUSTOM_AUDIENCE_ID>/users",
    "POST",
    {
        "payload": "{\"schema\":[\"EMAIL\",\"LOOKALIKE_VALUE\"],\"data\":[[\"9b431636bd164765d63c573c346708846af4f68fe3701a77a3bdd7e7e5166254\",44.5],[\"8cc62c145cd0c6dc444168eaeb1b61b351f9b1809a579cc9b4c9e9d7213a39ee\",140],[\"4eaf70b1f7a797962b9d2a533f122c8039012b31e0a52b34a426729319cb792a\",0],[\"98df8d46f118f8bef552b0ec0a3d729466a912577830212a844b73960777ac56\",0.9]]}"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Bundle params = new Bundle();
params.putString("payload", "{\"schema\":[\"EMAIL\",\"LOOKALIKE_VALUE\"],\"data\":[[\"9b431636bd164765d63c573c346708846af4f68fe3701a77a3bdd7e7e5166254\",44.5],[\"8cc62c145cd0c6dc444168eaeb1b61b351f9b1809a579cc9b4c9e9d7213a39ee\",140],[\"4eaf70b1f7a797962b9d2a533f122c8039012b31e0a52b34a426729319cb792a\",0],[\"98df8d46f118f8bef552b0ec0a3d729466a912577830212a844b73960777ac56\",0.9]]}");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/<CUSTOM_AUDIENCE_ID>/users",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"payload": @"{\"schema\":[\"EMAIL\",\"LOOKALIKE_VALUE\"],\"data\":[[\"9b431636bd164765d63c573c346708846af4f68fe3701a77a3bdd7e7e5166254\",44.5],[\"8cc62c145cd0c6dc444168eaeb1b61b351f9b1809a579cc9b4c9e9d7213a39ee\",140],[\"4eaf70b1f7a797962b9d2a533f122c8039012b31e0a52b34a426729319cb792a\",0],[\"98df8d46f118f8bef552b0ec0a3d729466a912577830212a844b73960777ac56\",0.9]]}",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/<CUSTOM_AUDIENCE_ID>/users"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X POST \
  -F 'payload={
       "schema": [
         "EMAIL",
         "LOOKALIKE_VALUE"
       ],
       "data": [
         [
           "9b431636bd164765d63c573c346708846af4f68fe3701a77a3bdd7e7e5166254",
           44.5
         ],
         [
           "8cc62c145cd0c6dc444168eaeb1b61b351f9b1809a579cc9b4c9e9d7213a39ee",
           140
         ],
         [
           "4eaf70b1f7a797962b9d2a533f122c8039012b31e0a52b34a426729319cb792a",
           0
         ],
         [
           "98df8d46f118f8bef552b0ec0a3d729466a912577830212a844b73960777ac56",
           0.9
         ]
       ]
     }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v7.0/<CUSTOM_AUDIENCE_ID>/users

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter	Description
`namespace` string	If extern_id provided and namespace specified, will match under specified namespace and update the mapping if necessary and pass permission check
`payload` Object	Payload representing users to add
`schema` string	`EMAIL_SHA256`, `PHONE_SHA256`, `MOBILE_ADVERTISER_ID`. One can also pass an array of multiple keys for multi-key match. Supported key types includes: `EXTERN_ID` `EMAIL` `PHONE` `GEN` `DOBY` `DOBM` `DOBD` `LN` `FN` `FI` `CT` `ST` `ZIP` `MADID` `COUNTRY` The multi-key array is of the form `["EMAIL", "LN", "FN", "ZIP"]`
`is_raw` boolean	Is the key raw? If the keys are combinational keys like "LN_FN_ZIP", set this to `false`, otherwise set this to `true`. Default to false
`data` list<JSON array>	Array with users data. If the multi-key feature is used, a two-dimensional array of the form `[["<HASHED_EMAIL>", "<HASHED_FN>", "<HASHED_LN>", "<HASHED_ZIP>"], ["", "<HASHED_FN>", "<HASHED_LN>", "<HASHED_ZIP>"]]` should be passed.In case a key is unknown, it should be left blank.
`app_ids` list<int>	App ids used by the users being uploaded. This field is required when `schema` is a Facebook UID and the IDs were collected by an App integration. e.g. `[1234,5678]`
`page_ids` list<Page ID>	Page ids used by the users being uploaded. This field is required when `schema` is a Facebook UID and the IDs were collected by a Page webhook integration. e.g. `[1234,5678]`
`data_source` Object	Indicates by which method the custom audience was created, defined by the `type` and `subtype` of the `data_source`
`type` enum {UNKNOWN, FILE_IMPORTED, EVENT_BASED, SEED_BASED, THIRD_PARTY_IMPORTED, COPY_PASTE, CONTACT_IMPORTER, HOUSEHOLD_AUDIENCE}	Type of the custom audience
`sub_type` enum {ANYTHING, NOTHING, HASHES, USER_IDS, HASHES_OR_USER_IDS, MOBILE_ADVERTISER_IDS, EXTERNAL_IDS, MULTI_HASHES, TOKENS, EXTERNAL_IDS_MIX, HOUSEHOLD_EXPANSION, WEB_PIXEL_HITS, MOBILE_APP_EVENTS, MOBILE_APP_COMBINATION_EVENTS, VIDEO_EVENTS, WEB_PIXEL_COMBINATION_EVENTS, PLATFORM, MULTI_DATA_EVENTS, IG_BUSINESS_EVENTS, STORE_VISIT_EVENTS, INSTANT_ARTICLE_EVENTS, FB_EVENT_SIGNALS, ENGAGEMENT_EVENT_USERS, CUSTOM_AUDIENCE_USERS, PAGE_FANS, CONVERSION_PIXEL_HITS, APP_USERS, S_EXPR, DYNAMIC_RULE, CAMPAIGN_CONVERSIONS, WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS, MOBILE_APP_CUSTOM_AUDIENCE_USERS, COMBINATION_CUSTOM_AUDIENCE_USERS, VIDEO_EVENT_USERS, FB_PIXEL_HITS, IG_PROMOTED_POST, PLACE_VISITS, OFFLINE_EVENT_USERS, EXPANDED_AUDIENCE, SEED_LIST, PARTNER_CATEGORY_USERS, PAGE_SMART_AUDIENCE, MULTICOUNTRY_COMBINATION, PLATFORM_USERS, MULTI_EVENT_SOURCE, SMART_AUDIENCE, LOOKALIKE_PLATFORM, MAIL_CHIMP_EMAIL_HASHES, CONSTANT_CONTACTS_EMAIL_HASHES, COPY_PASTE_EMAIL_HASHES, CONTACT_IMPORTER, DATA_FILE}	Subtype of the custom audience
`session` Object	Information about the session. Sessions are used when you have a lot of users to upload. For example, if you have 1 million users to upload, you need to split them into at least 100 requests because each request can only take 10k users. Specify the session info so that you can track if the session has finished or not.
`session_id` int64	Advertiser generated session identifier, used to track the session. Needs to be unique in the same ad account.
`estimated_num_total` int64	Estimated total num of users to be uploaded in this session, used by Facebook systems to better process this session.
`batch_seq` int64	A 1 based sequence number to identify the request in the session.
`last_batch_flag` boolean	`true` mean this request is the last request in this session. You must mark the last request otherwise Facebook doesn't know the session has ended

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

audience_id: numeric string,

session_id: numeric string,

num_received: int32,

num_invalid_entries: int32,

invalid_entry_samples: Map {

string: string

}

Validation Rules

Error	Description
200	Permissions error
2650	Failed to update the custom audience
100	Invalid parameter
105	The number of parameters exceeded the maximum for this operation
368	The action attempted has been deemed abusive or is otherwise disallowed
190	Invalid OAuth 2.0 Access Token
294	Managing advertisements requires an access token with the extended permission for ads_management
80003	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.

Deleting

Delete a test user

You can delete a User by making a DELETE request to /{user_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {

success: bool,

}

Validation Rules

Error	Description
100	Invalid parameter
2903	Cannot delete this test account
200	Permissions error
2904	Cannot delete the OG Test User
240	Desktop applications cannot call this function for other users

You can dissociate a User from a User by making a DELETE request to /{user_id}/businesses.

Parameters

Parameter Description

Parameter	Description
`business` numeric string or integer	SELF_EXPLANATORY

business

numeric string or integer

SELF_EXPLANATORY

Return Type

Struct {

success: bool,

}

Validation Rules

Error	Description
3914	It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager.

You can dissociate a User from a CustomAudience by making a DELETE request to /{custom_audience_id}/users.

Parameters

Parameter	Description
`namespace` string	If extern_id provided and namespace specified, will match under specified namespace and update the mapping if necessary and pass permission check
`payload` Object	Payload representing users to delete
`schema` string	`EMAIL_SHA256`, `PHONE_SHA256`, `MOBILE_ADVERTISER_ID`. One can also pass an array of multiple keys for multi-key match. Supported key types includes: `EXTERN_ID` `EMAIL` `PHONE` `GEN` `DOBY` `DOBM` `DOBD` `LN` `FN` `FI` `CT` `ST` `ZIP` `MADID` `COUNTRY` The multi-key array is of the form `["EMAIL", "LN", "FN", "ZIP"]`
`is_raw` boolean	Is the key raw? If the keys are combinational keys like "LN_FN_ZIP", set this to `false`, otherwise set this to `true`. Default to false
`data` list<JSON array>	Array with users data. If the multi-key feature is used, a two-dimensional array of the form `[["<HASHED_EMAIL>", "<HASHED_FN>", "<HASHED_LN>", "<HASHED_ZIP>"], ["", "<HASHED_FN>", "<HASHED_LN>", "<HASHED_ZIP>"]]` should be passed.In case a key is unknown, it should be left blank.
`app_ids` list<int>	App ids used by the users being uploaded. This field is required when `schema` is a Facebook UID and the IDs were collected by an App integration. e.g. `[1234,5678]`
`page_ids` list<Page ID>	Page ids used by the users being uploaded. This field is required when `schema` is a Facebook UID and the IDs were collected by a Page webhook integration. e.g. `[1234,5678]`
`data_source` Object	Indicates by which method the custom audience was created, defined by the `type` and `subtype` of the `data_source`
`type` enum {UNKNOWN, FILE_IMPORTED, EVENT_BASED, SEED_BASED, THIRD_PARTY_IMPORTED, COPY_PASTE, CONTACT_IMPORTER, HOUSEHOLD_AUDIENCE}	Type of the custom audience
`sub_type` enum {ANYTHING, NOTHING, HASHES, USER_IDS, HASHES_OR_USER_IDS, MOBILE_ADVERTISER_IDS, EXTERNAL_IDS, MULTI_HASHES, TOKENS, EXTERNAL_IDS_MIX, HOUSEHOLD_EXPANSION, WEB_PIXEL_HITS, MOBILE_APP_EVENTS, MOBILE_APP_COMBINATION_EVENTS, VIDEO_EVENTS, WEB_PIXEL_COMBINATION_EVENTS, PLATFORM, MULTI_DATA_EVENTS, IG_BUSINESS_EVENTS, STORE_VISIT_EVENTS, INSTANT_ARTICLE_EVENTS, FB_EVENT_SIGNALS, ENGAGEMENT_EVENT_USERS, CUSTOM_AUDIENCE_USERS, PAGE_FANS, CONVERSION_PIXEL_HITS, APP_USERS, S_EXPR, DYNAMIC_RULE, CAMPAIGN_CONVERSIONS, WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS, MOBILE_APP_CUSTOM_AUDIENCE_USERS, COMBINATION_CUSTOM_AUDIENCE_USERS, VIDEO_EVENT_USERS, FB_PIXEL_HITS, IG_PROMOTED_POST, PLACE_VISITS, OFFLINE_EVENT_USERS, EXPANDED_AUDIENCE, SEED_LIST, PARTNER_CATEGORY_USERS, PAGE_SMART_AUDIENCE, MULTICOUNTRY_COMBINATION, PLATFORM_USERS, MULTI_EVENT_SOURCE, SMART_AUDIENCE, LOOKALIKE_PLATFORM, MAIL_CHIMP_EMAIL_HASHES, CONSTANT_CONTACTS_EMAIL_HASHES, COPY_PASTE_EMAIL_HASHES, CONTACT_IMPORTER, DATA_FILE}	Subtype of the custom audience
`session` Object	Information about the session. Sessions are used when you have a lot of users to upload. For example, if you have 1 million users to upload, you need to split them into at least 100 requests because each request can only take 10k users. Specify the session info so that you can track if the session has finished or not.
`session_id` int64	Advertiser generated session identifier, used to track the session. Needs to be unique in the same ad account.
`estimated_num_total` int64	Estimated total num of users to be uploaded in this session, used by Facebook systems to better process this session.
`batch_seq` int64	A 1 based sequence number to identify the request in the session.
`last_batch_flag` boolean	`true` mean this request is the last request in this session. You must mark the last request otherwise Facebook doesn't know the session has ended

Return Type

Struct {

audience_id: numeric string,

session_id: numeric string,

num_received: int32,

num_invalid_entries: int32,

invalid_entry_samples: Map {

string: string

}

Validation Rules

Error	Description
80003	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
200	Permissions error
2650	Failed to update the custom audience
100	Invalid parameter
294	Managing advertisements requires an access token with the extended permission for ads_management
368	The action attempted has been deemed abusive or is otherwise disallowed

You can dissociate a User from an AdAccount by making a DELETE request to /act_{ad_account_id}/assigned_users.

Parameters

Parameter Description

Parameter	Description
`user` UID	Business user id or system user id Required

user

UID

Business user id or system user id

Required

Return Type

Struct {

success: bool,

}

Validation Rules

Error	Description
3919	There was an unexpected technical issue. Please try again.
100	Invalid parameter
5259	This ad account is closed. In order to continue advertising, you will need to create new ads.

You can dissociate a User from a Page by making a DELETE request to /{page_id}/blocked.

Parameters

Parameter	Description
`asid` user/page ID	App Scoped User ID to unblock
`psid` UID	Page Scoped User ID to unblock
`uid` UID	Deprecated. Same as `user`
`user` UID	List of User or Page IDs to unblock. This or `uid` is required

Return Type

Struct {

success: bool,

}

Validation Rules

Error	Description
100	Invalid parameter
210	User not visible