Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
audiences

Create one or multiple audiences

post/api/servicepool/audiences

Request body

OR

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

One or many audiences created.

Example response

{
  "data": {
    "activeCampaignCount": 1,
    "archivedAt": "2025-05-22T14:15:00.000+00:00",
    "archivedBy": "123e4567-e89b-12d3-a456-426614174000",
    "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",
    "deletedAt": "2025-05-22T14:15:00.000+00:00",
    "deletedBy": "123e4567-e89b-12d3-a456-426614174000",
    "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\"}}]}]}",
    "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
  }
}