Gambio icon

Gambio

Interact with Gambio REST API v3

Actions220

Customer (v3) → Update Favorite Status

AI-generated

Summary

Patch the favorite status of a customer in the Gambio system by specifying their ID and desired favorite state.

Inputs

  • Authentication — Select between Basic Auth (admin email and password) or Bearer Token (JWT) for authenticating with the Gambio API. Basic Auth supports both v2 and v3 APIs, whereas Bearer Token supports only v3.
  • Customer ID (required) — The unique ID of the customer whose favorite status you want to update.
  • Is Favorite — Boolean flag indicating whether the customer should be marked as a favorite (true) or not (false). Defaults to false.
  • Request Options — Optional settings for request handling such as batching (controls how many items per batch and interval between batches), ignoring SSL certificate issues, using a proxy, and setting a request timeout in milliseconds.

Output shape

a single API response object representing the update result from the Gambio endpoint.

The operation issues a PATCH request to the /api.php/v3/customers endpoint with a JSON body containing an array with an object specifying the customer ID and favorite status. The response includes the API's confirmation of the update. Pagination or multi-item handling is not applicable here since the update targets a single customer's favorite flag.

Discussion