Docs

Customers

Every customers endpoint, with its scope, parameters, a request and a response.

POST /customers/{id}/tags

Add tags (ones your audiences use) to a customer

Scope customers:write Returns 200

ParameterInTypeDescription
idrequired path string
dry_run query true true: validate and return the would-be result; nothing is saved
wait query true true: wait up to 20 s until the change is live at checkout
Idempotency-Key header string Retrying with the same key never applies the write twice (kept 24 h)
Request body (1 fields)
FieldTypeDescription
tagsrequired string[]

Request

curl -X POST "https://app.shopbird.app/api/v1/customers/{id}/tags" \
  -H "Authorization: Bearer sb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": [
    "string"
  ]
}'

Response 200

{
  "customer_id": "gid://shopify/Customer/123",
  "tags": [
    "vip"
  ],
  "added": true
}
DELETE /customers/{id}/tags

Remove tags from a customer

Scope customers:write Returns 200

ParameterInTypeDescription
idrequired path string
dry_run query true true: validate and return the would-be result; nothing is saved
wait query true true: wait up to 20 s until the change is live at checkout
Idempotency-Key header string Retrying with the same key never applies the write twice (kept 24 h)
If-Match header string The ETag from your last read; required where the resource is versioned
Request body (1 fields)
FieldTypeDescription
tagsrequired string[]

Request

curl -X DELETE "https://app.shopbird.app/api/v1/customers/{id}/tags" \
  -H "Authorization: Bearer sb_live_…" \
  -H 'If-Match: "v3"' \
  -H "Content-Type: application/json" \
  -d '{
  "tags": [
    "string"
  ]
}'

Response 200

{
  "customer_id": "gid://shopify/Customer/123",
  "tags": [
    "vip"
  ],
  "removed": true
}