Skip to main content
PUT
Scope required: tags.write
This endpoint allows for bulk upserting of tag values for specified users. If a tag with the specified key does not exist for the user / merchant pair, a new tag record is created with the specified values. If a tag with the specified key already exists, the tag values are updated. A maximum of 500 user_ids can be specified per API request. Currently, tags are merchant/user-scoped. This means that they are accessible to be managed by all integration partners a given merchant enables. Given this, for tags that are integration-specific and not general purpose user profile attributes, we recommend integration partners prefix tag keys with the name of your organization to avoid key usage conflicts between integrations enabled for a given merchant. eg:
  • thanx-custom-tag, rather than custom-tag, would be preferred for tags that are integration specific
  • allergens should still be used, if it’s expected that the tag be leveraged as a general-purpose user profile attribute
Tag keys are case-insensitive — Employee and employee are treated as the same key (writing one overwrites the other’s values), so use a consistent lowercase-with-hyphens convention.

​
Parameters

​
merchant_id
string
Merchant ID
​
user_ids
array<string>
User IDs (500 max per request)
user_ids must be each user’s Thanx identifier — the value returned as id by Get Users. An ID copied from a dashboard URL or a customer-data/SFTP export is a different encoding and will not match: the request returns 201 with zero tags written and no error. Confirm one test user lands before running a bulk write.
​
key
string
Tag key
​
values
array(string)
Array of tag values (50 max)

​
Response