---
title: "Update advertiser defined events"
method: PATCH
path: "/ad_accounts/{ad_account_id}/advertiser_defined_events"
tags: ["conversions"]
---

# Update advertiser defined events

`PATCH /ad_accounts/{ad_account_id}/advertiser_defined_events`

## Request

- Base URL: `https://api.pinterest.com/v5`
- URL: `https://api.pinterest.com/v5/ad_accounts/{ad_account_id}/advertiser_defined_events`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://www.pinterest.com/oauth/`
    - Token URL: `https://api.pinterest.com/v5/oauth/token` scopes: `ads:write`
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.pinterest.com/v3/oauth/access_token/` scopes: `ads:write`
- TypeScript: <https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/ad_accounts/:ad_account_id/advertiser_defined_events/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update advertiser defined event names or mappings for the given ad account.

## Path parameters

- `ad_account_id` string, required

## Request body

- AdvertiserDefinedEventsCreateRequest: Request body for creating or updating advertiser defined events
  - `items` AdvertiserDefinedEventInput[], required: List of advertiser defined events to create or update
    - `mapped_conversion_type` 'SIGNUP' | 'ADD_TO_CART' | 'LEAD' | 'CHECKOUT' | 'SUBSCRIBE' | 'ADD_TO_WISHLIST' | 'ADD_PAYMENT_INFO' | 'INITIATE_CHECKOUT' | 'CONTACT' | 'CUSTOMIZE_PRODUCT' | 'FIND_LOCATION' | 'SCHEDULE' | 'SUBMIT_APPLICATION' | 'START_TRIAL' | 'PAGE_VISIT' | 'VIEW_CATEGORY' | 'VIEW_CONTENT' | 'SEARCH' | 'WATCH_VIDEO', required: Pinterest standard event types that a custom event can be mapped to. Restricted to event types that are valid ads optimization goals.
    - `name` string, required: Raw string name of the event

## Response `200`

The request has succeeded.

- object
  - `items` AdvertiserDefinedEventProcessingRecord[], required
    - `exceptions` string[]: List of exception messages if the operation failed
    - `name` string, required: Name of the advertiser defined event
    - `status` string, required: Processing status (success or failure)

## Other responses

- `400`: The request could not be understood by the server due to unexpected data.
- `401`: Authentication is required and has either failed or not been provided.
- `403`: The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404`: The requested resource could not be found on this server.
- `429`: The user has sent too many requests in a given amount of time and is being rate limited.
- `default`: An unexpected error response.

## Changes

- **2026-06-04** (v5) `b698c180678a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/ad_accounts/:ad_account_id/advertiser_defined_events/patch.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) - [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pinterest/apis/pinterest-rest-api/revisions/b698c180678a?raw)