Audience Profiles

Create audience profile import

Queues a bounded CSV import of customer-supplied team profiles. Exact CSV header names can be mapped to profile fields. At most one import is active per team. Files contain at most 10 MiB and 10,000 rows; the CSV is removed after completion or cancellation. The same replay key, file and mapping return the existing job. Requires beta enrollment.

Requires a team API key with campaigns:manage. Project tokens are not accepted.

POST

platform

audience-profile-imports

Create audience profile import

curl --request POST \
  --url https://api.polymorfa.com/platform/audience-profile-imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "replayKey": "<string>",
  "csvBase64": "aSDinaTvuI8gbWludGxpZnk="
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({replayKey: '<string>', csvBase64: 'aSDinaTvuI8gbWludGxpZnk='})
};

fetch('https://api.polymorfa.com/platform/audience-profile-imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/audience-profile-imports"

payload = {
    "replayKey": "<string>",
    "csvBase64": "aSDinaTvuI8gbWludGxpZnk="
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/audience-profile-imports"

	payload := strings.NewReader("{\n  \"replayKey\": \"<string>\",\n  \"csvBase64\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state": "queued",
    "totalValid": 1,
    "invalidCount": 1,
    "invalidSamples": [
      {
        "row": 3,
        "reason": "<string>"
      }
    ],
    "conflictSamples": [
      {
        "row": 3,
        "reason": "quota"
      }
    ],
    "processedValid": 1,
    "createdCount": 1,
    "updatedCount": 1,
    "conflictCount": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "completedAt": 1
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json

replayKey

string

required

Specifies replay key for this schema.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters
Pattern	`^[A-Za-z0-9._:-]+$`

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9._:-]+$

csvBase64

string<byte>

required

UTF-8 CSV encoded as standard padded base64; decoded file at most 10 MiB and 10,000 data rows. The tags cell holds a JSON array of strings and the attributes cell a JSON object, quoted as CSV requires, for example +15550100001,"[""vip""]","{""city"":""Lisbon""}".

Value constraints

Constraint	Accepted input
String length	`1` through `13981016` characters
Format	`byte`

Required string length: 1 - 13981016

mapping

object

Maps profile fields to exact CSV header names. Required when the CSV uses different headers; unmapped CSV columns are ignored.

Show child attributes

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Create audience profile import

curl --request POST \
  --url https://api.polymorfa.com/platform/audience-profile-imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "replayKey": "<string>",
  "csvBase64": "aSDinaTvuI8gbWludGxpZnk="
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({replayKey: '<string>', csvBase64: 'aSDinaTvuI8gbWludGxpZnk='})
};

fetch('https://api.polymorfa.com/platform/audience-profile-imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/audience-profile-imports"

payload = {
    "replayKey": "<string>",
    "csvBase64": "aSDinaTvuI8gbWludGxpZnk="
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/audience-profile-imports"

	payload := strings.NewReader("{\n  \"replayKey\": \"<string>\",\n  \"csvBase64\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state": "queued",
    "totalValid": 1,
    "invalidCount": 1,
    "invalidSamples": [
      {
        "row": 3,
        "reason": "<string>"
      }
    ],
    "conflictSamples": [
      {
        "row": 3,
        "reason": "quota"
      }
    ],
    "processedValid": 1,
    "createdCount": 1,
    "updatedCount": 1,
    "conflictCount": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "completedAt": 1
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Create audience profile import

Authorizations

Body

Response