PATCH /api/profile
Account required · HTTP API reference
All endpoints · Authentication and retries · Download OpenAPI
- Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
- Send at least one of feedState, filters or workspaceState. Existing nested state is merged. Do not include unsafe object keys.
- Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.
Request
| Parameter | Location | Type and requirement |
|---|---|---|
Origin | header | string · required An origin allowed by this deployment. |
X-CSRF-Token | header | string · required Must match the CSRF cookie issued to this browser. |
Body · application/json
feedState optional · objectView feedState model
selectedTag optional · stringminLength: 1. maxLength: 120
Additional fields: JSON values.
filters optional · objectApplication-owned JSON state. Keys vary with the saved view; unsafe object keys are rejected.. Application-owned JSON state. Keys vary with the saved view; unsafe object keys are rejected.
workspaceState optional · objectView workspaceState model
backtestDrafts optional · objectApplication-owned JSON state. Keys vary with the saved view; unsafe object keys are rejected.. Application-owned JSON state. Keys vary with the saved view; unsafe object keys are rejected.
backtestResults optional · objectApplication-owned JSON state. Keys vary with the saved view; unsafe object keys are rejected.. Application-owned JSON state. Keys vary with the saved view; unsafe object keys are rejected.
Additional fields: JSON values.
Example
Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.
{
"feedState": {
"selectedTag": "All"
}
}curl --include \
--request PATCH \
'https://api.weavers.app/api/profile' \
--cookie cookies.txt --cookie-jar cookies.txt \
--header 'Origin: https://weavers.app' \
--header "X-CSRF-Token: ${CSRF_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @request.jsonResponses
200 · Successful response.
application/json
{
"profile": {
"updatedAt": "2025-01-01T00:00:00.000Z",
"feedState": {
"selectedTag": "example"
},
"filters": {},
"workspaceState": {
"backtestDrafts": {},
"backtestResults": {}
}
}
}View response model
profile required · objectView profile model
updatedAt required · stringfeedState required · objectView feedState model
selectedTag required · stringAdditional fields: JSON values.
filters required · objectView filters model
Additional fields: JSON value.
workspaceState required · objectView workspaceState model
backtestDrafts required · objectView backtestDrafts model
Additional fields: JSON value.
backtestResults required · objectView backtestResults model
Additional fields: JSON value.
Additional fields: JSON values.
Additional fields: JSON values.
Additional fields: JSON values.
400 · Invalid request.
application/json
{
"error": "example"
}View response model
Variant 1: object
error required · stringAdditional fields: JSON values.
401 · Authentication is missing or invalid.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
403 · Permission, origin or CSRF check failed.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
429 · Rate limit reached; honor Retry-After when supplied.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
500 · Server failure.
application/json
{
"error": "example"
}View response model
error required · stringAdditional fields: JSON values.