v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

audiences

Find and update an audience

Partially update one existing audience

patch/api/servicepool/audiences/{identifier}

Path parameters

identifierstring uuid required

audience unique identifier

Request body

clickRatenumber

The click rate of the audience as a fractional percentage (e.g. 0.2365 for 23.65%)

descriptionstring

The description of the audience

filterValuesstring

The filter values of the audience

filtersstring

The filters of the audience

namestring required

The name of the audience

openRatenumber

The open rate of the audience as a fractional percentage (e.g. 0.2365 for 23.65%)

Example request

{
  "clickRate": 0.2365,
  "description": "Audience for states excluding MO",
  "filterValues": "[[{\"id\":\"homeAddress.state\",\"operator\":\"ne\",\"value\":\"MO\",\"type\":\"string\"}]]",
  "filters": "{\"or\":[{\"or\":[],\"and\":[{\"homeAddress.state\":{\"ne\":\"MO\"}}]}]}",
  "name": "Audience for states excluding MO",
  "openRate": 0.2365,
  "proximity": {
    "distance": 1,
    "unit": "mile",
    "locationUuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "vectors": {
    "jobMatch": {
      "matchThreshold": 60,
      "matchType": "Job",
      "matchUuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Response

Successfully updated audience