API documentation

Responses

• 200OKResponse fields ▾

  Name	Description
  organizationobject
  organization.idstring
  organization.namestring
  keyobject
  key.idstring
  key.namestring
  key.prefixstring
  key.scopesstring[]
  key.expires_atstring (date-time) | null
  rate_limitobject
  rate_limit.per_minuteinteger

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/me" \
  -H "Authorization: Bearer $API_KEY"

const response = await fetch('https://app.basketly.io/api/v1/me', {
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
  },
})
if (!response.ok) throw new Error((await response.json()).error.message)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://app.basketly.io/api/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['API_KEY']}",
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

<?php
$ch = curl_init('https://app.basketly.io/api/v1/me');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
    throw new RuntimeException($data['error']['message']);
}
print_r($data);

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  dataContact[]Required
  data[].idstring	Contact id.
  data[].namestring	Full name.
  data[].phonestring	Phone in E.164 form, empty when unknown.
  data[].emailstring	E-mail, empty when unknown.
  data[].tagsstring[]	Tags.
  data[].sms_optoutboolean	True when SMS to this person are blocked.
  data[].first_sourcestring	Where the person first came from ("Zamówienie w sklepie", "Ręcznie", API…).
  data[].status_idstring | null	Internal status id (GET /contact-statuses), null when none. Never sent to Meta.
  data[].owner_idstring | null	User id of the person's owner (opiekun).
  data[].last_activity_atstring (date-time) | null	Last activity time.
  data[].created_atstring (date-time)	Creation time.
  data[].updated_atstring (date-time)	Last change; use with updated_since.
  data[].ordersobject	What the person bought in the shop.
  data[].orders.countinteger	Bought, not cancelled shop orders.
  data[].orders.valuenumber	Their value in currency.
  data[].orders.currencystring	The currency most of the orders use.
  data[].orders.first_atstring (date-time) | null	First order time.
  data[].orders.last_atstring (date-time) | null	Last order time.
  next_cursorstring | nullRequired	Pass as cursor to get the next page; null on the last page.
  has_morebooleanRequired	True when another page exists.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/contacts" \
  -H "Authorization: Bearer $API_KEY"

const response = await fetch('https://app.basketly.io/api/v1/contacts', {
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
  },
})
if (!response.ok) throw new Error((await response.json()).error.message)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://app.basketly.io/api/v1/contacts",
    headers={
        "Authorization": f"Bearer {os.environ['API_KEY']}",
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

<?php
$ch = curl_init('https://app.basketly.io/api/v1/contacts');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
    throw new RuntimeException($data['error']['message']);
}
print_r($data);

Parameters

Request body application/json

Responses

• 201CreatedResponse fields ▾

  Name	Description
  idstring	Contact id.
  namestring	Full name.
  phonestring	Phone in E.164 form, empty when unknown.
  emailstring	E-mail, empty when unknown.
  tagsstring[]	Tags.
  sms_optoutboolean	True when SMS to this person are blocked.
  first_sourcestring	Where the person first came from ("Zamówienie w sklepie", "Ręcznie", API…).
  status_idstring | null	Internal status id (GET /contact-statuses), null when none. Never sent to Meta.
  owner_idstring | null	User id of the person's owner (opiekun).
  last_activity_atstring (date-time) | null	Last activity time.
  created_atstring (date-time)	Creation time.
  updated_atstring (date-time)	Last change; use with updated_since.
  ordersobject	What the person bought in the shop.
  orders.countinteger	Bought, not cancelled shop orders.
  orders.valuenumber	Their value in currency.
  orders.currencystring	The currency most of the orders use.
  orders.first_atstring (date-time) | null	First order time.
  orders.last_atstring (date-time) | null	Last order time.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/contacts" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anna Nowak",
    "phone": "+48600100200",
    "email": "anna@example.com",
    "tags": [
      "vip"
    ]
  }'

const response = await fetch('https://app.basketly.io/api/v1/contacts', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
    'Idempotency-Key': '5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Anna Nowak",
    "phone": "+48600100200",
    "email": "anna@example.com",
    "tags": [
      "vip"
    ]
  }),
})
if (!response.ok) throw new Error((await response.json()).error.message)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.post(
    "https://app.basketly.io/api/v1/contacts",
    headers={
        "Authorization": f"Bearer {os.environ['API_KEY']}",
        "Idempotency-Key": "5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b",
    },
    json={
        "name": "Anna Nowak",
        "phone": "+48600100200",
        "email": "anna@example.com",
        "tags": ["vip"],
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

<?php
$ch = curl_init('https://app.basketly.io/api/v1/contacts');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('API_KEY'),
        'Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'name' => 'Anna Nowak',
        'phone' => '+48600100200',
        'email' => 'anna@example.com',
        'tags' => ['vip'],
    ]),
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
    throw new RuntimeException($data['error']['message']);
}
print_r($data);

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  idstring	Contact id.
  namestring	Full name.
  phonestring	Phone in E.164 form, empty when unknown.
  emailstring	E-mail, empty when unknown.
  tagsstring[]	Tags.
  sms_optoutboolean	True when SMS to this person are blocked.
  first_sourcestring	Where the person first came from ("Zamówienie w sklepie", "Ręcznie", API…).
  status_idstring | null	Internal status id (GET /contact-statuses), null when none. Never sent to Meta.
  owner_idstring | null	User id of the person's owner (opiekun).
  last_activity_atstring (date-time) | null	Last activity time.
  created_atstring (date-time)	Creation time.
  updated_atstring (date-time)	Last change; use with updated_since.
  ordersobject	What the person bought in the shop.
  orders.countinteger	Bought, not cancelled shop orders.
  orders.valuenumber	Their value in currency.
  orders.currencystring	The currency most of the orders use.
  orders.first_atstring (date-time) | null	First order time.
  orders.last_atstring (date-time) | null	Last order time.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/contacts/abc123" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 200OKResponse fields ▾

  Name	Description
  idstring	Contact id.
  namestring	Full name.
  phonestring	Phone in E.164 form, empty when unknown.
  emailstring	E-mail, empty when unknown.
  tagsstring[]	Tags.
  sms_optoutboolean	True when SMS to this person are blocked.
  first_sourcestring	Where the person first came from ("Zamówienie w sklepie", "Ręcznie", API…).
  status_idstring | null	Internal status id (GET /contact-statuses), null when none. Never sent to Meta.
  owner_idstring | null	User id of the person's owner (opiekun).
  last_activity_atstring (date-time) | null	Last activity time.
  created_atstring (date-time)	Creation time.
  updated_atstring (date-time)	Last change; use with updated_since.
  ordersobject	What the person bought in the shop.
  orders.countinteger	Bought, not cancelled shop orders.
  orders.valuenumber	Their value in currency.
  orders.currencystring	The currency most of the orders use.
  orders.first_atstring (date-time) | null	First order time.
  orders.last_atstring (date-time) | null	Last order time.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X PATCH "https://app.basketly.io/api/v1/contacts/abc123" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anna Nowak",
    "phone": "+48600100200",
    "email": "anna@example.com",
    "tags": [
      "vip"
    ]
  }'

Parameters

Request body application/json

Responses

• 201CreatedResponse fields ▾

  Name	Description
  idstring	History entry id.
  contact_idstring	Contact id.
  kindstring	Entry kind.
  textstring	Text.
  timestring (date-time)	Entry time.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/contacts/abc123/notes" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "call",
    "text": "Asked when order 1001 will ship."
  }'

Parameters

Request body application/json

Responses

• 200OKResponse fields ▾

  Name	Description
  idstring	Contact id.
  namestring	Full name.
  phonestring	Phone in E.164 form, empty when unknown.
  emailstring	E-mail, empty when unknown.
  tagsstring[]	Tags.
  sms_optoutboolean	True when SMS to this person are blocked.
  first_sourcestring	Where the person first came from ("Zamówienie w sklepie", "Ręcznie", API…).
  status_idstring | null	Internal status id (GET /contact-statuses), null when none. Never sent to Meta.
  owner_idstring | null	User id of the person's owner (opiekun).
  last_activity_atstring (date-time) | null	Last activity time.
  created_atstring (date-time)	Creation time.
  updated_atstring (date-time)	Last change; use with updated_since.
  ordersobject	What the person bought in the shop.
  orders.countinteger	Bought, not cancelled shop orders.
  orders.valuenumber	Their value in currency.
  orders.currencystring	The currency most of the orders use.
  orders.first_atstring (date-time) | null	First order time.
  orders.last_atstring (date-time) | null	Last order time.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/contacts/abc123/tags" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "add": [
      "vip"
    ],
    "remove": [
      "cold"
    ]
  }'

Parameters

Request body application/json

Responses

• 200OKResponse fields ▾

  Name	Description
  idstring	Contact id.
  namestring	Full name.
  phonestring	Phone in E.164 form, empty when unknown.
  emailstring	E-mail, empty when unknown.
  tagsstring[]	Tags.
  sms_optoutboolean	True when SMS to this person are blocked.
  first_sourcestring	Where the person first came from ("Zamówienie w sklepie", "Ręcznie", API…).
  status_idstring | null	Internal status id (GET /contact-statuses), null when none. Never sent to Meta.
  owner_idstring | null	User id of the person's owner (opiekun).
  last_activity_atstring (date-time) | null	Last activity time.
  created_atstring (date-time)	Creation time.
  updated_atstring (date-time)	Last change; use with updated_since.
  ordersobject	What the person bought in the shop.
  orders.countinteger	Bought, not cancelled shop orders.
  orders.valuenumber	Their value in currency.
  orders.currencystring	The currency most of the orders use.
  orders.first_atstring (date-time) | null	First order time.
  orders.last_atstring (date-time) | null	Last order time.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/contacts/abc123/sms-optout" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "sms_optout": true
  }'

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  dataobject[]	People: id, name, status, owner, tags, last activity, added (created), orders (count, value, first and last), shops (source kinds of bought orders), duplicate (a possible duplicate hint), open_tasks and overdue_tasks (members who see tasks).
  per_pageinteger	People per page.
  totalinteger	All matching people.
  pageinteger	Page number.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/contacts/search" \
  -H "Authorization: Bearer $API_KEY"

Responses

• 200OKResponse fields ▾

  Name	Description
  statusesobject[]	Statuses: id, name, archived, sort, people.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/contact-statuses" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 200OKResponse fields ▾

  Name	Description
  statusstring	Status id ("" = none).
  ownerstring	Owner id.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/contacts/abc123/status" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "purchase"
  }'

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  dataobject[]	History lines: kind, time, actor, summary, details.
  pageinteger	Page number (?page=).
  moreboolean	An older page exists.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/contacts/abc123/history" \
  -H "Authorization: Bearer $API_KEY"

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/segments" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  dataEvent[]Required
  data[].idstring	Event id.
  data[].source_idstring	Source id.
  data[].external_idstring	Your record id.
  data[].statusstring	Your status.
  data[].meta_event_idstring	Meta deduplication id.
  data[].event_timestring (date-time) | null	Event time.
  data[].valuenumber | null	Value.
  data[].currencystring	Currency.
  data[].deliveriesDelivery[]	Deliveries of this event.
  data[].deliveries[].idstring	Delivery id.
  data[].deliveries[].event_idstring	Basketly event id.
  data[].deliveries[].target_idstring	Meta receiver (dataset connection) id.
  data[].deliveries[].dataset_idstring	Meta dataset (pixel) id.
  data[].deliveries[].event_namestring	Meta event name, e.g. Purchase, AddToCart.
  data[].deliveries[].meta_event_idstring	event_id sent to Meta.
  data[].deliveries[].modestring	test or live.
  data[].deliveries[].statusstring	Delivery status.Values: pending, sending, retry, accepted, failed, cancelled
  data[].deliveries[].attemptsinteger	Attempts so far.
  data[].deliveries[].last_errorstring	Last error, empty when none.
  data[].deliveries[].accepted_atstring (date-time) | null	When Meta accepted it (receipt, not proof of attribution).
  data[].deliveries[].next_attempt_atstring (date-time) | null	Next attempt.
  data[].deliveries[].created_atstring (date-time)	Creation time.
  data[].deliveries[].updated_atstring (date-time)	Last change.
  data[].created_atstring (date-time)	Creation time.
  data[].updated_atstring (date-time)	Last change.
  next_cursorstring | nullRequired	Pass as cursor to get the next page; null on the last page.
  has_morebooleanRequired	True when another page exists.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/events" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 202Accepted into the queueResponse fields ▾

  Name	Description
  event_idstring	Basketly event id.
  deliveries_createdinteger	New deliveries queued for Meta datasets.
  duplicatesinteger	Deliveries skipped as duplicates.
  sending_enabledboolean	False when the server does not send to Meta (queued only).

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/events" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "src_abc123",
    "external_id": "order-1001",
    "status": "purchase",
    "consent": true,
    "event_time": "2026-10-08T10:00:00Z",
    "email": "anna@example.com",
    "phone": "+48600100200",
    "value": 1200,
    "currency": "PLN"
  }'

const response = await fetch('https://app.basketly.io/api/v1/events', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
    'Idempotency-Key': '5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "source": "src_abc123",
    "external_id": "order-1001",
    "status": "purchase",
    "consent": true,
    "event_time": "2026-10-08T10:00:00Z",
    "email": "anna@example.com",
    "phone": "+48600100200",
    "value": 1200,
    "currency": "PLN"
  }),
})
if (!response.ok) throw new Error((await response.json()).error.message)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.post(
    "https://app.basketly.io/api/v1/events",
    headers={
        "Authorization": f"Bearer {os.environ['API_KEY']}",
        "Idempotency-Key": "5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b",
    },
    json={
        "source": "src_abc123",
        "external_id": "order-1001",
        "status": "purchase",
        "consent": True,
        "event_time": "2026-10-08T10:00:00Z",
        "email": "anna@example.com",
        "phone": "+48600100200",
        "value": 1200,
        "currency": "PLN",
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

<?php
$ch = curl_init('https://app.basketly.io/api/v1/events');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('API_KEY'),
        'Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'source' => 'src_abc123',
        'external_id' => 'order-1001',
        'status' => 'purchase',
        'consent' => true,
        'event_time' => '2026-10-08T10:00:00Z',
        'email' => 'anna@example.com',
        'phone' => '+48600100200',
        'value' => 1200,
        'currency' => 'PLN',
    ]),
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
    throw new RuntimeException($data['error']['message']);
}
print_r($data);

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  idstring	Event id.
  source_idstring	Source id.
  external_idstring	Your record id.
  statusstring	Your status.
  meta_event_idstring	Meta deduplication id.
  event_timestring (date-time) | null	Event time.
  valuenumber | null	Value.
  currencystring	Currency.
  deliveriesDelivery[]	Deliveries of this event.
  deliveries[].idstring	Delivery id.
  deliveries[].event_idstring	Basketly event id.
  deliveries[].target_idstring	Meta receiver (dataset connection) id.
  deliveries[].dataset_idstring	Meta dataset (pixel) id.
  deliveries[].event_namestring	Meta event name, e.g. Purchase, AddToCart.
  deliveries[].meta_event_idstring	event_id sent to Meta.
  deliveries[].modestring	test or live.
  deliveries[].statusstring	Delivery status.Values: pending, sending, retry, accepted, failed, cancelled
  deliveries[].attemptsinteger	Attempts so far.
  deliveries[].last_errorstring	Last error, empty when none.
  deliveries[].accepted_atstring (date-time) | null	When Meta accepted it (receipt, not proof of attribution).
  deliveries[].next_attempt_atstring (date-time) | null	Next attempt.
  deliveries[].created_atstring (date-time)	Creation time.
  deliveries[].updated_atstring (date-time)	Last change.
  created_atstring (date-time)	Creation time.
  updated_atstring (date-time)	Last change.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/events/abc123" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  dataDelivery[]Required
  data[].idstring	Delivery id.
  data[].event_idstring	Basketly event id.
  data[].target_idstring	Meta receiver (dataset connection) id.
  data[].dataset_idstring	Meta dataset (pixel) id.
  data[].event_namestring	Meta event name, e.g. Purchase, AddToCart.
  data[].meta_event_idstring	event_id sent to Meta.
  data[].modestring	test or live.
  data[].statusstring	Delivery status.Values: pending, sending, retry, accepted, failed, cancelled
  data[].attemptsinteger	Attempts so far.
  data[].last_errorstring	Last error, empty when none.
  data[].accepted_atstring (date-time) | null	When Meta accepted it (receipt, not proof of attribution).
  data[].next_attempt_atstring (date-time) | null	Next attempt.
  data[].created_atstring (date-time)	Creation time.
  data[].updated_atstring (date-time)	Last change.
  next_cursorstring | nullRequired	Pass as cursor to get the next page; null on the last page.
  has_morebooleanRequired	True when another page exists.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/deliveries" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/conversions/balance" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  dataobject[]	Tasks by due time.
  countsobject	Counts per section (overdue, today, later, none).
  truncatedboolean	More than 500 open tasks.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/tasks" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 201CreatedResponse fields ▾

  Name	Description
  idstringRequired	New record id.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/contacts/abc123/tasks" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "example"
  }'

Parameters

Request body application/json

Responses

• 204Done
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/tasks/abc123/done" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "entry": {
      "kind": "call",
      "text": "Asked when order 1001 will ship."
    }
  }'

Parameters

Request body application/json

Responses

• 204Moved
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/tasks/abc123/postpone" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "days": 1,
    "due_date": "example",
    "due_time": "example"
  }'

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/integrations" \
  -H "Authorization: Bearer $API_KEY"

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/getting-started" \
  -H "Authorization: Bearer $API_KEY"

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/map" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  ordersobject[]	Orders: id, number, placed_at, status, status_type (new, open, closed, cancelled), paid, bought, cancelled, currency, total, shipping, items, city, buyer {id, name}, source_name, source_kind (shoper, idosell, baselinker, woocommerce, shopify…), lines (line count), first_product {name, variant, content_id, quantity, product (record id or empty), image}, sends ([{destination meta | ga4 | tiktok | pinterest | klaviyo | openai_ads | google_ads | microsoft_ads, status accepted | failed | waiting | skipped}] — the worst outcome per destination), ad_source. ad_source = Basketly's own last-click reading of where the order came from, never a platform's attribution: platform (meta | google_ads | microsoft_ads | tiktok | pinterest | openai_ads | email | comparison | other | direct | unknown), method (click_id | utm | ids | feed | referrer | none), link (server = tracking_id in the order, browser = thank-you page linkOrder, shop = the shop's landing data, none), deduced, campaign / adset / ad {id, name}, resolved (ids | names | empty), utm {source, medium, campaign, content, term, id}, click_at, clicks (click ids of the visit: fbc, gclid, gbraid, wbraid, msclkid, ttclid, ttp, epik, oppref, obref), referrer (host), landing (path), first_touch, feed {id, name, channel, product} (the served feed and catalogue product of the tagged link the visit landed on).
  ad_facetsobject	Orders of the selection (before the platform / campaign filters) per ad platform (platforms: platform, orders) and per campaign (campaigns: platform, key, name, orders; at most 100).
  facetsobject	The period's orders (all states, before the other filters) per shop (sources: id, name, kind, orders), shop status (shop_statuses: status, status_type, orders) and delivery country (countries: country, orders); at most 100 each.
  page_sizeinteger	Orders per page (per_page).
  totalinteger	All matching orders.
  summaryobject	Bought orders, unpaid, cancelled, items, revenue per currency, average basket, buyers, new and returning buyers.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/orders" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/orders/abc123" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OKResponse fields ▾

  Name	Description
  productsobject[]	Products: id, external_id, title, price, sale_price, availability, stock, score 0–100, worst problem, issues, errors, warnings, origin_name, origin_kind, google {id, path, by person|own|auto|title|none, confidence, review — an automatic or by-title pick under 60 to check}, fixes {auto, manual}, stats of the period, trend (bought units per day, per week over 30 days).
  totalinteger	All matching products.
  summaryobject	Counts of the selection: errors, warnings, average score, problems by code.
  per_pageinteger	Products per page.
  facetsobject	With facets=1: origins (id, name, kind, products), categories and brands (name, products; top 500), availability, google (set, review, none) and fixes (auto, manual) counts of the whole selection.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/products" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/products/performance" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/products/abc123/stats" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/products/abc123" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X PUT "https://app.basketly.io/api/v1/products/abc123/overrides" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "overrides": {}
  }'

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/guidelines" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.
• 502MiniMax did not answer or gave no title that passes the guidelines (upstream_error).
• 503AI suggestions are off on this server: no MiniMax key (unavailable).

Example

curl -X POST "https://app.basketly.io/api/v1/products/abc123/title-suggestions" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/meta-catalog/status" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/products/unseen-flow" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "days": 7,
    "below": 1
  }'

Responses

• 200OKResponse fields ▾

  Name	Description
  feedsobject[]	Feeds as in GET /feeds/{id} without fields, plus category_coverage {covered, products}: products that leave the feed with a Google category (as on the Kategorie Google tab), null when it cannot be counted.

• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/feeds" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 413Body over 64 KB (payload_too_large).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/feeds" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: 5f0c7a2e-8d41-4b6a-9e3f-1c2d3e4f5a6b" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anna Nowak",
    "input": "url",
    "url": "https://example.com/webhooks"
  }'

Parameters

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl "https://app.basketly.io/api/v1/feeds/abc123" \
  -H "Authorization: Bearer $API_KEY"

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 413Body over 64 KB (payload_too_large).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X PATCH "https://app.basketly.io/api/v1/feeds/abc123" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anna Nowak",
    "url": "https://example.com/webhooks"
  }'

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 413Body over 64 KB (payload_too_large).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/feeds/abc123/link-tagging/preview" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "preset": "marker",
    "params": "example",
    "ads_redirect": true
  }'

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 413Body over 64 KB (payload_too_large).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X PUT "https://app.basketly.io/api/v1/feeds/abc123/rules" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rules": [
      {}
    ]
  }'

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 413Body over 64 KB (payload_too_large).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X PUT "https://app.basketly.io/api/v1/feeds/abc123/flow" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "graph": {}
  }'

Parameters

Request body application/json

Responses

• 200OK
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 413Body over 64 KB (payload_too_large).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.

Example

curl -X POST "https://app.basketly.io/api/v1/feeds/abc123/preview" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rules": [
      {}
    ],
    "graph": {}
  }'

Parameters

Responses

• 204Queued
• 400Invalid input (validation_error, invalid_json, invalid_cursor).
• 401Missing, unknown, revoked or expired key (unauthorized, key_revoked, key_expired).
• 403The key lacks the scope (insufficient_scope, details.required_scope).
• 404No such record in your organisation (not_found).
• 409Conflicts with the current state (conflict, contact_exists, contact_merged, event_conflict, source_paused, idempotency_in_progress).
• 422Idempotency-Key reused with a different body (idempotency_key_reused).
• 429Over 120 requests per minute for this key (rate_limited); wait Retry-After seconds.