Skip to main content
POST
/
api
/
v3
/
admin
/
customers
/
bulk_add_tags
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const result = await client.customers.bulkAddTags({
  ids: ['cus_UkLWZg9DAJ', 'cus_QrLWXg9CAJ'],
  tags: ['vip', 'newsletter'],
})
{
  "customer_count": 1,
  "tag_count": 2
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Body

application/json
ids
string[]
required
Example:
["cus_UkLWZg9DAJ"]
tags
string[]
required
Example:
["vip", "newsletter"]

Response

200 - application/json

tags added

customer_count
integer
tag_count
integer