Skip to main content
POST
/
audiences
/
{audienceId}
/
import
cURL
curl --request POST \
  --url https://admin.fanfare.io/api/audiences/{audienceId}/import \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "errorCount": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "processedConsumers": 123,
  "progress": 123,
  "s3Key": "<string>",
  "uploadUrl": "<string>",
  "errors": [
    {
      "issues": [
        "<unknown>"
      ],
      "row": 123
    }
  ],
  "totalConsumers": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>"
}

Authorizations

​
Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Path Parameters

​
audienceId
string
required

Response

Audience import created successfully

​
archived
boolean
required
​
audienceId
string<uuid>
required
​
createdAt
string<date-time>
required
​
createdBy
string
required
​
errorCount
number
required
​
id
string<uuid>
required
​
organizationId
string<uuid>
required
​
processedConsumers
number
required
​
progress
number
required
​
s3Key
string
required
​
status
enum<string>
required
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
uploadUrl
string
required
​
errors
object[] | null
​
totalConsumers
number | null
​
updatedAt
string<date-time> | null
​
updatedBy
string | null