Appearance

Update Custom audiences ​

Endpoint ​

http
PATCH /unified/ads/custom_audiences/{id}
Integrations supported
  • Google Ads
  • LinkedIn

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

account_id
string

The unique identifier for the account.

Required in
  • Google Ads
name
string

The name of the custom audience.

Required in
  • Google Ads
description
string

The description of the custom audience.

Required in
  • Google Ads
members
object[]

A list of audience members.

Required in
  • Google Ads
  • LinkedIn
first_name
string

Set only if type is USER. The first name of the user.

last_name
string

Set only if type is USER. The last name of the user.

title
string

Set only if type is USER. The job title of the user.

company
string

The name of the company.

country
string

The country associated with the user or company.

url
string
keyword
string
email
string

Set only if type is USER. The email address of the user.

phone
string
application
string
location_category
string
google_advertiser_id
string

Set only if type is USER. The Google Advertiser ID of the user.

website
string

Set only if type is COMPANY. The website domain of the company.

domain
string

Set only if type is COMPANY. The email domain of the company.

organization_urn
string

Set only if type is COMPANY. The unique organization URN (Uniform Resource Name).

linkedin_url
string

Set only if type is COMPANY. The LinkedIn URL of the company.

type
string
REQUIRED · 
All possible enum values:
  • url
  • keyword
  • application
  • location_category
type
string

The type of custom audience.

All possible enum values:
  • USER
  • COMPANY
Enum support by integration
  • LinkedIn
    • USER
    • COMPANY
Required in
  • LinkedIn
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string

The unique identifier for the custom audience.

name
string

The name of the custom audience.

description
string

The description of the custom audience.

type
string

The type of custom audience.

source
string

The source of custom audience.

status
string

The status of the custom audience.

All possible enum values:
  • active
  • inactive
  • archived
  • deleted
  • with_issues
  • in_progress
  • failed
  • expired
account_id
string

The unique identifier for the account.

members
object[]

A list of audience members.

first_name
string
last_name
string
title
string
company
string
country
string
url
string
keyword
string
email
string
phone
string
application
string
location_category
string
google_advertiser_id
string
website
string
domain
string
organization_urn
string
linkedin_url
string
created_at
string · date-time

The date and time the account was created.

updated_at
string · date-time

The date and time the account was last updated.

remote_data
object

Raw data returned from the remote API call.