---
title: "Create one or multiple audiences"
method: POST
path: "/api/servicepool/audiences"
tags: ["audiences"]
---

# Create one or multiple audiences

`POST /api/servicepool/audiences`

## Request body

- union
  - AudienceDtoInput
    - `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
    - `filterValues` string — The filter values of the audience
    - `filters` string — The filters of the audience
    - `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
  - AudienceDtoInput[]
    - `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
    - `filterValues` string — The filter values of the audience
    - `filters` string — The filters of the audience
    - `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 `201`

One or many audiences created.

- object
  - `data` union
    - AudienceDto
      - `activeCampaignCount` number — The number of active audience campaigns
      - `archivedAt` string, date-time — The date and time the audience was archived
      - `archivedBy` string — The unique identifier of the user who archived the audience
      - `audienceCampaignCount` number — The number of audience campaigns
      - `clickRate` number — The click rate of the audience as a fractional percentage (e.g. 0.2365 for 23.65%)
      - `clicked` number — The number of clicked messages
      - `companyUuid` string, required — The unique identifier of the company
      - `createdAt` string, date-time, required — The date and time the audience was created
      - `createdBy` string, required — The unique identifier of the user who created the audience
      - `deletedAt` string, date-time — The date and time the audience was deleted
      - `deletedBy` string — The unique identifier of the user who deleted the audience
      - `delivered` number — The number of delivered messages
      - `description` string — The description of the audience
      - `filterValues` string — The filter values of the audience
      - `filters` string — The filters of the audience
      - `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%)
      - `opened` number — The number of opened messages
      - `pipeline` string — The pipeline of the audience
      - `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
      - `sent` number — The number of sent messages
      - `status` 'active' | 'archived' | 'deleted' — The status of the audience
      - `talentCount` number — The number of talents in the audience
      - `updatedAt` string, date-time, required — The date and time the audience was updated
      - `updatedBy` string, required — The unique identifier of the user who updated the audience
      - `uuid` string, required — The unique identifier of the audience
      - `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
      - `version` number — The version of the audience
      - `isHidden` boolean — Whether the audience is hidden or not
    - AudienceDto[]
      - `activeCampaignCount` number — The number of active audience campaigns
      - `archivedAt` string, date-time — The date and time the audience was archived
      - `archivedBy` string — The unique identifier of the user who archived the audience
      - `audienceCampaignCount` number — The number of audience campaigns
      - `clickRate` number — The click rate of the audience as a fractional percentage (e.g. 0.2365 for 23.65%)
      - `clicked` number — The number of clicked messages
      - `companyUuid` string, required — The unique identifier of the company
      - `createdAt` string, date-time, required — The date and time the audience was created
      - `createdBy` string, required — The unique identifier of the user who created the audience
      - `deletedAt` string, date-time — The date and time the audience was deleted
      - `deletedBy` string — The unique identifier of the user who deleted the audience
      - `delivered` number — The number of delivered messages
      - `description` string — The description of the audience
      - `filterValues` string — The filter values of the audience
      - `filters` string — The filters of the audience
      - `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%)
      - `opened` number — The number of opened messages
      - `pipeline` string — The pipeline of the audience
      - `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
      - `sent` number — The number of sent messages
      - `status` 'active' | 'archived' | 'deleted' — The status of the audience
      - `talentCount` number — The number of talents in the audience
      - `updatedAt` string, date-time, required — The date and time the audience was updated
      - `updatedBy` string, required — The unique identifier of the user who updated the audience
      - `uuid` string, required — The unique identifier of the audience
      - `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
      - `version` number — The version of the audience
      - `isHidden` boolean — Whether the audience is hidden or not
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `status` string
    - `duration` number
    - `size` number

## 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)