---
title: "POST /v1/{+parent}/userLists"
method: POST
path: "/v1/{+parent}/userLists"
tags: ["accountTypes"]
---

# POST /v1/{+parent}/userLists

`POST /v1/{+parent}/userLists`

Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

## Path parameters

- `parent` string, required

## Query parameters

- `validateOnly` boolean

## Request body

- UserList — A user list resource.
  - `readOnly` boolean — Output only. An option that indicates if a user may edit a list.
  - `integrationCode` string — Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  - `description` string — Optional. A description of the user list.
  - `closingReason` 'CLOSING_REASON_UNSPECIFIED' | 'UNUSED' — Output only. The reason why this user list membership status is closed.
  - `name` string — Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
  - `displayName` string — Required. The display name of the user list.
  - `targetNetworkInfo` TargetNetworkInfo — Eligibility information for different target networks.
    - `eligibleForDisplay` boolean — Output only. Indicates this user list is eligible for Google Display Network.
    - `eligibleForSearch` boolean — Optional. Indicates if this user list is eligible for Google Search Network.
  - `ingestedUserListInfo` IngestedUserListInfo — Represents a user list that is populated by user provided data.
    - `contactIdInfo` ContactIdInfo — Additional information when `CONTACT_ID` is one of the `upload_key_types`.
      - `dataSourceType` 'DATA_SOURCE_TYPE_UNSPECIFIED' | 'DATA_SOURCE_TYPE_FIRST_PARTY' | 'DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU' | 'DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE' | 'DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA' — Optional. Immutable. Source of the upload data
      - `matchRatePercentage` integer — Output only. Match rate for customer match user lists.
    - `mobileIdInfo` MobileIdInfo — Additional information when `MOBILE_ID` is one of the `upload_key_types`.
      - `keySpace` 'KEY_SPACE_UNSPECIFIED' | 'IOS' | 'ANDROID' — Required. Immutable. The key space of mobile IDs.
      - `dataSourceType` 'DATA_SOURCE_TYPE_UNSPECIFIED' | 'DATA_SOURCE_TYPE_FIRST_PARTY' | 'DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU' | 'DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE' | 'DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA' — Optional. Immutable. Source of the upload data.
      - `appId` string — Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
    - `uploadKeyTypes` string[] — Required. Immutable. Upload key types of this user list.
    - `userIdInfo` UserIdInfo — Additional information when `USER_ID` is one of the `upload_key_types`.
      - `dataSourceType` 'DATA_SOURCE_TYPE_UNSPECIFIED' | 'DATA_SOURCE_TYPE_FIRST_PARTY' | 'DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU' | 'DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE' | 'DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA' — Optional. Immutable. Source of the upload data.
    - `partnerAudienceInfo` PartnerAudienceInfo — Additional information for partner audiences. This feature is only available to data partners.
      - `partnerAudienceSource` 'PARTNER_AUDIENCE_SOURCE_UNSPECIFIED' | 'COMMERCE_AUDIENCE' | 'LINEAR_TV_AUDIENCE' | 'AGENCY_PROVIDER_AUDIENCE' — Required. Immutable. The source of the partner audience.
      - `commercePartner` string — Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
    - `pairIdInfo` PairIdInfo — Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
      - `matchRatePercentage` integer — Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
      - `advertiserIdentifierCount` string, int64 — Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
      - `publisherId` string, int64 — Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
      - `publisherName` string — Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
      - `cleanRoomIdentifier` string — Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
    - `pseudonymousIdInfo` PseudonymousIdInfo — Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
      - `billableRecordCount` string, int64 — Optional. Immutable. The number of billable records (e.g. uploaded or matched).
      - `syncStatus` 'SYNC_STATUS_UNSPECIFIED' | 'CREATED' | 'READY_FOR_USE' | 'FAILED' — Output only. Sync status of the user list.
  - `id` string, int64 — Output only. The unique ID of the user list.
  - `accessReason` 'ACCESS_REASON_UNSPECIFIED' | 'OWNED' | 'SHARED' | 'LICENSED' | 'SUBSCRIBED' | 'AFFILIATED' — Output only. The reason this account has been granted access to the list.
  - `membershipDuration` string, google-duration — Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
  - `membershipStatus` 'MEMBERSHIP_STATUS_UNSPECIFIED' | 'OPEN' | 'CLOSED' — Optional. Membership status of this user list.
  - `sizeInfo` SizeInfo — Estimated number of members in this user list in different target networks.
    - `gmailMembersCount` string, int64 — Output only. Estimated number of members in this user list on Gmail.
    - `searchNetworkMembersCount` string, int64 — Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.
    - `youtubeMembersCount` string, int64 — Output only. Estimated number of members in this user list on YouTube.
    - `displayNetworkMembersCount` string, int64 — Output only. Estimated number of members in this user list, on the Google Display Network.
  - `accountAccessStatus` 'ACCESS_STATUS_UNSPECIFIED' | 'ENABLED' | 'DISABLED' — Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`.

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/datamanager.md) · [All operations](https://skmtc.dev/google/apis/datamanager/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/datamanager/revisions/a26378ca9ba8/schema)