---
title: "Update audience via Copilot"
method: PATCH
path: "/api/servicepool/copilot/audiences/{identifier}"
tags: ["audiences"]
---

# Update audience via Copilot

`PATCH /api/servicepool/copilot/audiences/{identifier}`

## Path parameters

- `identifier` string, uuid, required

## Request body

- AudienceDtoCopilotInput
  - `clickRate` number — The click rate of the audience as a fractional percentage (e.g. 0.2365 for 23.65%)
  - `description` string — The description of the audience
  - `filters` array[], required — Collection of filter groups which are logically ORed together
    - object[] — Collection of filter groups which are logically ANDed together
      - `id` union, required — The unique identifier of the filter.
        - 'hireApplicants.rejectionReason' | 'hireApplicants.rejectionDate' | 'hireApplicants.stage.title' | 'hireApplicants.createdAt' | 'hireApplicants.positionUuid' | 'hireApplicants.concepts.values.conceptOptionUuid' | 'wxWorkers.employmentStatus.type' | 'wxWorkers.employmentStatus.subtype' | 'homeAddress.city' | 'homeAddress.state' | 'homeAddress.zip' | 'talentType'
        - string
      - `operator` 'eq' | 'ne' | 'regex' | 'regex:startsWith' | 'regex:doesNotStartWith' | 'regex:endsWith' | 'regex:doesNotEndWith' | 'regex:contains' | 'regex:doesNotContain' | 'regex:exists' | 'regex:doesNotExist' | 'regex:isEmpty' | 'regex:isNotEmpty' | 'or:isEmptyOrMissing' | 'in' | 'nin' | 'all' | 'gt' | 'gte' | 'lt' | 'lte', required — The operator of the filter. 'in' and 'nin' are used for select and array filters, but 'all' is only used for array filters. Any operator starting with 'regex' is only usable for string filters. 'gt', 'gte', 'lt', 'lte' are only usable for number or date filters. 'eq' is used for string, number, boolean, and date filters. 'ne' is used for string, number, and boolean filters. 'or:isEmptyOrMissing' is used for string and date filters.
      - `type` 'string' | 'array' | 'number' | 'date' | 'boolean' | 'select', required — The type of the filter. 'hireApplicants.rejectionReason', 'hireApplicants.stage.title', 'hireApplicants.positionUuid', 'hireApplicants.concepts.values.conceptOptionUuid', 'wxWorkers.employmentStatus.type', 'wxWorkers.employmentStatus.subtype', and 'talentType' are select type. 'homeAddress.city', 'homeAddress.state', and 'homeAddress.zip' are string type. 'hireApplicants.createdAt' and 'hireApplicants.rejectionDate' are date type. Custom attribute filters are based on the type of the custom attribute.
      - `value` union, required — The value of the filter. For 'talentType', value MUST be an array containing only: "worker", "applicant", or "prospect". Do NOT use "wxWorker", "Worker", "Applicant", or "Prospect".
        - string
        - number
        - boolean
        - string[]
        - number[]
        - boolean[]
  - `name` string, required — The name of the audience
  - `openRate` number — The open rate of the audience as a fractional percentage (e.g. 0.2365 for 23.65%)
  - `proximity` object, nullable
    - `distance` number, required — The numeric distance from location
    - `unit` 'mile' | 'kilometer', required — The unit of measurement
    - `locationUuid` string, required — The unique identifier of the location to check distance against
  - `vectors` object, nullable
    - `jobMatch` object, nullable
      - `matchThreshold` number, required — The match threshold of the job match vector
      - `matchType` 'Job' | 'Opening', required — The match type of the job match vector
      - `matchUuid` string, required — The unique identifier of the job match vector

## Response `204`

Successfully updated audience

## Other responses

- `422` — default error response
- `500` — default error response

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/versions/5f406c0e9462/schema)