PIpinterest
business_access_assets

Create a new asset group.

Changed on

Create a new asset group with the specified parameters.

  • An asset group is a custom group of assets based on how you would like to manage your accounts.
post/businesses/{business_id}/asset_groups

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

Request body

asset_group_descriptionstring required

Asset group description.

asset_group_namestring required

Asset Group name.

asset_group_typesAssetGroupType[] required

Asset Group Types. Note: The asset group types are used for user reference and categorization purposes only and do not impact the functionality of the asset group.

Example request

{
  "asset_group": {
    "ad_accounts_ids": [
      "549755885175"
    ],
    "asset_group_description": "Asset group that has ad accounts used in Canada",
    "asset_group_name": "Canada Ad Accounts",
    "asset_group_types": [
      "LOCATION_OR_LANGUAGE"
    ],
    "catalogs_ids": [
      "4836859046874"
    ],
    "created_by": {
      "email": "business0101@business.com",
      "id": "549755885175",
      "username": "business0101"
    },
    "created_time": 1646767577816,
    "id": "666791336903426391",
    "owner": {
      "email": "business0101@business.com",
      "id": "549755885175",
      "username": "business0101"
    },
    "profiles_ids": [
      "630433785246278264"
    ],
    "updated_time": 1646767577816
  },
  "asset_group_description": "Asset groups that has ad accounts shared in Canada",
  "asset_group_name": "Canada Ad Accounts",
  "asset_group_types": [
    "BRAND",
    "LOCATION_OR_LANGUAGE",
    "PRODUCT_LINE",
    "OTHER"
  ]
}

Response

The request has succeeded.

Example response

{
  "asset_group": {
    "ad_accounts_ids": [
      "549755885175"
    ],
    "asset_group_description": "Asset group that has ad accounts used in Canada",
    "asset_group_name": "Canada Ad Accounts",
    "asset_group_types": [
      "LOCATION_OR_LANGUAGE"
    ],
    "catalogs_ids": [
      "4836859046874"
    ],
    "created_by": {
      "email": "business0101@business.com",
      "id": "549755885175",
      "username": "business0101"
    },
    "created_time": 1646767577816,
    "id": "666791336903426391",
    "owner": {
      "email": "business0101@business.com",
      "id": "549755885175",
      "username": "business0101"
    },
    "profiles_ids": [
      "630433785246278264"
    ],
    "updated_time": 1646767577816
  }
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the success response with the status

  • v510f9eba4ad97Revision changes
    • info

      added the optional property / to the response with the status