Create a buyer (phantom) and related contacts/locations

curl --request POST \ --url https://integrations.polinate.ai/api/v1/buyers \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <x-api-key>' \ --header 'X-Business-Id: <x-business-id>' \ --data ' { "buyer": { "name": "Acme Pty Ltd", "legalName": "Acme Pty Ltd" } } '

Headers

X-Business-Id

string

required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

X-API-Key

string

required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

Idempotency-Key

string

Idempotency key for POST operations

Example:

"{{idempotencyKey}}"

Body

application/json

buyer

object

required

Show child attributes

partnershipStatus

enum<string>

Available options:

DECLINED,

PENDING,

REVIEW,

ACTIVE,

PAUSED,

SUSPENDED,

EXPIRED,

TERMINATED

phones

object[]

Show child attributes

emails

object[]

Show child attributes

locations

object[]

Show child attributes

Response

Created

success

boolean

required

phantomId

string

required

partnershipId

string

required

Items

Buyers

Pricing

Invoices

Orders

Create a buyer (phantom) and related contacts/locations

Headers

Body

Response