Idempotently star a resource or update its bookmark
PUT
/v1/account/favorites/{resourceType}/{resourceId}Requires resources:write. Stores only this caller's title and navigation preference. It does not resolve resource content or grant access, ownership, sharing, or execution. Retry keeps the original added time. A navigation organizationId must match the active organization.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| resourceType | path | string | Yes | — |
| resourceId | path | string | Yes | — |
Query parameters
None.
Header parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| X-Computer-Agents-Organization | header | string | No | — |
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| title | string | Yes | Display title. |
| navigation | object | Yes | Allowlisted platform navigation fields only, each a nonempty string of at most 512 characters; total JSON at most 4096 characters. URLs, credentials, arbitrary keys, package-origin access context and resource content are rejected. See the Favourites contract for the navigation field inventory. |
| navigation.page | thread | tasks | calendar | metronome | resources | tools | files | team | organization | knowledge | packages | channels | guardrails | evaluations | tests | assurance | fine-tuning | quality | inference | models | resource-templates | develop-webhooks | develop-api-keys | develop-security | develop-evidence-agents | batches | Yes | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Saved favouriteapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| favorite | object | Yes | — |
| favorite.resourceType | string | Yes | — |
| favorite.resourceId | string | Yes | — |
| favorite.title | string | Yes | Display title. |
| favorite.navigation | object | Yes | Allowlisted platform navigation fields only, each a nonempty string of at most 512 characters; total JSON at most 4096 characters. URLs, credentials, arbitrary keys, package-origin access context and resource content are rejected. See the Favourites contract for the navigation field inventory. |
| favorite.navigation.page | thread | tasks | calendar | metronome | resources | tools | files | team | organization | knowledge | packages | channels | guardrails | evaluations | tests | assurance | fine-tuning | quality | inference | models | resource-templates | develop-webhooks | develop-api-keys | develop-security | develop-evidence-agents | batches | Yes | — |
| favorite.createdAt | string | Yes | ISO 8601 timestamp. |
| favorite.updatedAt | string | Yes | ISO 8601 timestamp. |
400Invalid identity
None.
401Authentication required
None.
403Insufficient scope or inactive organization membership
None.
500Favourites storage failed
None.
Idempotently star a resource or update its bookmark
Loading...
Response 200
Loading...