Update wishlist
Update wishlist details for the authenticated user
PATCH
/api/v1/{app_id}/wishlists/{id}- API
- Auth
- OpenAPI
- auth-api
- Updated
- Apr 26, 2026
auth-api:PATCH:/api/v1/{app_id}/wishlists/{id}
Update wishlist details for the authenticated user
API ownership
- API family: Auth API
- Best for: Customer identity, session, token, cart, and wishlist flows.
- Do not use from: Merchant admin data syncs or public catalog rendering.
- Guide route: /apis/auth/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
PATCH - Path:
/api/v1/\{app_id\}/wishlists/\{id\} - Summary: Update wishlist
- Description: Update wishlist details for the authenticated user
- OpenAPI contract: auth-api
- Operation ID: Not documented in the OpenAPI contract.
Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| app_id | path | Yes | string | UUID of the app |
| id | path | Yes | string | UUID of the wishlist |
Request body
- Required: Yes
- Description: Wishlist update data
- Content: application/json (object)
Update Wishlist Request
| Property | Type | Required | Details |
|---|---|---|---|
is_default | boolean | No | - |
name | string | No | minLength: 1 |
Generated example (synthetic):
{
"is_default": false,
"name": "string"
}Responses
| Status | Description | Content |
|---|---|---|
| 200 | OK | application/json (object) |
| 400 | Invalid request | application/json (object) |
| 401 | Unauthorized | application/json (object) |
| 404 | Wishlist not found | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Wishlist
| Property | Type | Required | Details |
|---|---|---|---|
created_at | string | No | - |
id | string | No | - |
is_default | boolean | No | - |
item_count | integer | No | - |
name | string | No | - |
updated_at | string | No | - |
user_id | string | No | - |
Generated example (synthetic):
{
"created_at": "string",
"id": "string",
"is_default": false,
"item_count": 0,
"name": "string",
"updated_at": "string",
"user_id": "string"
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}401 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}404 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Auth API
- Method:
PATCH - Path:
/api/v1/\{app_id\}/wishlists/\{id\} - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Wishlist
- OpenAPI summary: Update wishlist