Loyalty Admin API
AdjustCustomerState3
Adjusts loyalty program state of the given customer.
| Method | POST |
|---|---|
| Kind | Write |
| URL | https://app.bubblehouse.com/api/v2023061/<shop>/AdjustCustomerState3 |
| Authentication | Shop TokenAdmin Customer Token |
Note that because networking is unreliable, each call needs to have a unique idempotency key, and repeated calls with the same key do nothing and silently succeed. This means that you can safely retry calls failed due to networking errors. To help with testing, use an option that simulates a 500 error.
Input
A customer to operate upon, when using a shop token.
If you're using a customer token and decide to pass this field (which we do not recommend), it must match the customer from the token.
The adjustments to perform.
Output
A successful response has no meaningful properties and only contains an ok property always set to true:
{"ok": true}Specific Errors
| Status | Error | Reason & Examples |
|---|---|---|
None. | ||
API-wide Errors
| Status | Error | Reason & Examples |
|---|---|---|
None. | ||
Global Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 401 | invalid_token | The provided authentication token is invalid or has expired. {"id":"invalid_token","message":"The token has expired"} |
| 429 | rate_limit_exceeded | Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase. {"id":"rate_limit_exceeded","message":"You are over the read limit per second for this customer"} |
| 400 | obsolete_global_api_version | The global API version you are trying to use is no longer supported. {"id":"obsolete_global_api_version"} |
| 400 | invalid_global_api_version | The global API version you are trying to use has never existed. {"id":"invalid_global_api_version"} |
| 400 | inaccessible_global_api_version | The global API version you are trying to use is not enabled on your account. {"id":"inaccessible_global_api_version"} |