Skip to main content
POST
Prepare Creative Placements

Authorizations

x-api-key
string
header
required

A server-side Bily API key created under Settings > AI tools > Access keys. Select the intended workspace before creating it.

Headers

x-bily-organization-id
string

An organization ID returned by GET /context or GET /organizations. Omit it when a scoped key supplies the organization. Otherwise provide it when no organization is selected.

Example:

"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"

Path Parameters

storeUrl
string
required

Exact workspace URL returned by GET /context.

generationId
string
required

Identifier returned by the matching Bily read or creation operation.

Body

application/json
placementProfiles
enum<string>[]
required
Required array length: 1 - 3 elements
Available options:
feed,
fullscreen,
square,
pin
demandSource
enum<string>
required
Available options:
user,
campaign
idempotencyKey
string
required
Required string length: 8 - 256

Response

Read the returned identifier until processing reaches a terminal state. Acceptance alone does not confirm completion.

The response is of type object.