FOfountain
audiences

Find and update an audience

Update one existing audience. Only the fields sent change, and name is required.

patch/api/servicepool/audiences/{identifier}

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/servicepool/audiences/{identifier}
  • Auth
    HTTP bearer

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

Audience updated. meta.planLimit carries a notice when the company plan hides part of the filter.

Example response

{
  "data": {
    "activeCampaignCount": 1,
    "archivedAt": "2025-05-22T14:15:00.000+00:00",
    "archivedBy": "123e4567-e89b-12d3-a456-426614174000",
    "archivedVia": "human",
    "audienceCampaignCount": 1,
    "clickRate": 0.2365,
    "clicked": 1,
    "companyUuid": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-05-22T14:15:00.000+00:00",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdVia": "human",
    "deletedAt": "2025-05-22T14:15:00.000+00:00",
    "deletedBy": "123e4567-e89b-12d3-a456-426614174000",
    "deletedVia": "human",
    "delivered": 1,
    "description": "Audience for states excluding MO",
    "filterValues": "[[{\"id\":\"homeAddress.state\",\"operator\":\"ne\",\"value\":\"MO\",\"type\":\"string\"}]]",
    "filters": "{\"or\":[{\"or\":[],\"and\":[{\"homeAddress.state\":{\"ne\":\"MO\"}}]}]}",
    "membershipRefreshedAt": "2025-05-22T14:15:00.000+00:00",
    "membershipRefreshBlocked": {
      "reason": "coverage-building",
      "at": "2026-09-03T20:44:33.782Z"
    },
    "name": "Audience for states excluding MO",
    "openRate": 0.2365,
    "opened": 1,
    "pipeline": "[{\"$match\":{\"companyUuid\":\"e3d9a3e0-f758-43be-8767-e7034e08a7b8\"}},{\"$match\":{}},{\"$sort\":{\"_id\":1}}]",
    "proximity": {
      "distance": 1,
      "unit": "mile",
      "locationUuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sent": 1,
    "status": "active",
    "talentCount": 1,
    "updatedAt": "2025-05-22T14:15:00.000+00:00",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "vectors": {
      "jobMatch": {
        "matchThreshold": 60,
        "matchType": "Job",
        "matchUuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "version": 1
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.