Update the client's public identity
Replaces the client's public identity — display name, category, description and logo — as Explore shows it.
/v1/clients/{clientId}/profileReplaces the client's public identity — display name, category, description and logo — as Explore shows it. Needs authority over the client — membership of its organization, an API key bound to this client, or tenant staff holding clients:manage; anything else is refused not_client_member or insufficient_scope (403), and an unknown client client_not_found (404). A field outside its bounds, or a logo URL the service will not accept, gives invalid_request (400).
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X PUT "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/profile" \ -H "Content-Type: application/json" \ -d '{ "display_name": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "org_alias": "string", "display_name": "string", "category": "string", "description": "string", "logo_url": "string", "commission_bps": 0, "status": "pending", "approved_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}Fetch a client (members and loop staff)
Fetches one client with its profile, status, commission override and the merchant it settles to.
The client's own offerings, one page at a time
The client's own offerings in every status, with the merchant view of each variant: cost, markup, pricing mode and stock counts, none of which Explore ever shows a shopper.