On this page
putMyAppData
mutation · in the family Your own session
What it does
Save one of your own per-app preferences at this organization — your theme, language, or a layout choice.
Save ONE of your own app-private values at this organization. value ≤ 8 KB UTF-8; app/name ride the STRICT grammars ([a-z][a-z0-9-]{0,31} / [a-z0-9][a-z0-9._-]{0,63}). SELF-scoped BY CONSTRUCTION — no userId/orgId argument exists. Requires authentication.
What happens
Yours alone, per app and per organization; saving the same name again simply replaces it.
Who may call it
Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:putMyAppData
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
app | String String! | yes | No further notes. |
name | String String! | yes | No further notes. |
value | String String! | yes | No further notes. |
Returns
MyAppDataEntry MyAppDataEntry! — One of the calling user's own app-private values.
Example request
mutation ExamplePutMyAppData($app: String!, $name: String!, $value: String!) {
putMyAppData(app: $app, name: $name, value: $value) {
app
name
value
createdAt
updatedAt
revision
revisionNum
}
}
Variables:
{
"app": "<app>",
"name": "Blue jeans",
"value": "<value>"
}
Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.
Example response
{
"data": {
"putMyAppData": {
"app": "<app>",
"name": "Blue jeans",
"value": "<value>",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revision": "01900000-0000-7000-8000-b7960e180000",
"revisionNum": 1
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": {
"name": "genesis",
"number": 0
},
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)CONFLICT/*— The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)VALIDATION/VERSION_REQUIRED— The request did not say which app version it came from. (VALIDATION)