media_library

Edit one or more media library assets for a business. Assets are reusable image or video creatives at the business level, not Pins. Use this to rename assets and update their tags in Media library. This does not replace the image or video file.

The editable fields are name and tags. Omitting a field, or sending it as null, leaves it unchanged. To change tags, send the full replacement list; send an empty list ([]) to remove all tags. The name can be changed but not cleared. Each entry must set at least one of name or tags, and at most 100 assets may be edited per request.

Per-asset outcomes are reported in the response body, not in the HTTP status: an authorized, well-formed request returns 200 even when some or all of the requested assets were not updated. Read status for the overall outcome and results for each asset. Entries in results are returned in the same order as the request assets. A successful entry carries asset.asset_id; on failure the asset snapshot is omitted, so match failures to the request by position.

Access requires the token user to be the business owner or to have a Business Access role with media library edit access: Admin, Campaign Manager, or Profile Publisher.

patch/media_library/businesses/{business_id}/assets

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    OAuth 2
    Authorization codehttps://www.pinterest.com/oauth/
    Token URLhttps://api.pinterest.com/v5/oauth/token
    Scopesads:write

Path parameters

business_idstring required

Identifier of the business that owns the media library.

Request body

Example request

{
  "assets": [
    {
      "asset_id": "950259590150898564",
      "name": "Updated name",
      "tags": [
        "lifestyle",
        "updated"
      ]
    }
  ]
}

Response

The request has succeeded.

status'SUCCESS' | 'PARTIAL_SUCCESS' | 'ERROR' required

Overall outcome of a bulk operation.

success_countinteger required

Number of successfully updated assets.

failure_countinteger required

Number of assets that failed to update.

Example response

{
  "success_count": 1,
  "failure_count": 1,
  "results": [
    {
      "error_code": "ASSET_NOT_FOUND",
      "asset": {
        "asset_id": "950259590150898564",
        "business_id": "950259727533690363",
        "name": "Black fuzzy crocs",
        "has_been_promoted": true,
        "tags": [
          "tag1",
          "tag2"
        ],
        "created_at": 1767225600000,
        "updated_at": 1767225600000
      }
    }
  ]
}

Changes