Skip to main content

Use marketing campaigns

Use the marketing campaign by associating the campaign_id to a listing or an email claim. You can do so when creating a listing, editing a listing, and creating a new email claim.

In their respective POST or PATCH requests, provide the campaign_id in the payload.

POST /listings
Example payload
"campaign_id": "762f86b9-3a45-43ef-a617-2562839a20ed"

The response should also include the provided campaign_id.

Example response
"id": "4e339560-5c6c-495a-bfe3-0a30e3519983",
"status": "ACTIVE",
"quantity_listed": 1,
"quantity_remaining": 1,
"sale_type": "DEFAULT",
"policy": {
"type": "FCFS",
"max_per_user": 1,
"payment_session_duration": {
"timeout_seconds": 600,
"provider_override": { "COINBASE": 300 }
"email_claim_duration": 7200,
"item_assignment_strategy": "AUTOMATIC",
"tx_payer": "SELLER"
"start_time": "2022-11-08T09:00:00+00:00",
"end_time": "2022-12-08T09:00:00+00:00",
"collection_id": null,
"item_id": "12b4659a-0796-4021-b21e-a376494b674c",
"price": "25000",
"currency": "USD",
"settlement_currency": {
"max_quantity_per_tx": 1,
"payment_providers": ["STRIPE", "COINBASE", "MINT_VOUCHER"],
"campaign_id": "762f86b9-3a45-43ef-a617-2562839a20ed"