API Reference

Update Audience

patch
https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/audiences

You can update a custom audience using this endpoint.

Body Params
int64
required

ID of the advertiser.

int64
required

ID of custom audience.

string

The name of the audience.
Note: Limit on length of audience name is 120 characters.

string

Audience description.
Note: Limit on length of description is 120 characters.

string
enum

The type of audience to be updated.

Allowed:
audienceObjective
array of strings

Objective of the custom audience.
Note: Not applicable for Advanced Targeting audiences.

audienceObjective
Allowed:
string

Objective of the custom audience. Not applicable for Advanced Targeting audiences.
Note: This value is required when audienceObjective includes OTHER in the array.

string
enum

Defines the type of custom audience.
Note: Required only when updating audienceDefinition.

Allowed:
audienceDefinition
object

JSON object to define various criteria for the custom audience.
Must include this object when editing any nested objects.

Headers
string
required

Auth signature as an API key.

string
required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

integer
required

We will provide you with the KEY VERSION to access the API.
It is same for all advertisers you access through the API. The allowed value is 1.

integer
required

Timestamp for which the auth signature is generated. Use Unix epoch format.

string
required

This is bearer token.
The token will provide you the access to the API. It is same for all advertisers you access through the API.

Responses

Updated about 6 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?