Dry-run audience count

POST/v1/campaigns/dry-run-audience

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

audience_source_idstring

audience_source_typestring

contact_idsstring[] | null

Responses

200OK

countinteger<int64>required

samplesAudienceSampleContactOutput[] | null

Show properties

Array of AudienceSampleContactOutput

emailstring

idstringrequired

namestring

phonestring

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/campaigns/dry-run-audience" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_source_id": "string",
  "audience_source_type": "string",
  "contact_ids": [
    "string"
  ]
}'

const response = await fetch("/v1/campaigns/dry-run-audience", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "audience_source_id": "string",
  "audience_source_type": "string",
  "contact_ids": [
    "string"
  ]
})
});

import requests

response = requests.post(
    "/v1/campaigns/dry-run-audience",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "audience_source_id": "string",
  "audience_source_type": "string",
  "contact_ids": [
    "string"
  ]
},
)

Response

{
  "count": 0,
  "samples": [
    {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}