Write a value

curl --request PUT \
  --url https://api.tassyir.io/apps/2026-10/data/{ownerType}/{ownerId}/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<unknown>"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<unknown>'})
};

fetch('https://api.tassyir.io/apps/2026-10/data/{ownerType}/{ownerId}/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "<string>",
    "ownerType": "business",
    "ownerId": "<string>",
    "key": "<string>",
    "value": "<unknown>",
    "visibility": "app",
    "declared": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "<string>",
    "ownerType": "business",
    "ownerId": "<string>",
    "key": "<string>",
    "value": "<unknown>",
    "visibility": "app",
    "declared": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "APP_DATA_KEY_NOT_DECLARED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "APP_TOKEN_INVALID",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "PERMISSION_DENIED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "NOT_FOUND",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 409,
  "detail": "<string>",
  "code": "APP_DATA_LIMIT_REACHED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "PAYLOAD_TOO_LARGE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 422,
  "detail": "<string>",
  "code": "IDEMPOTENCY_KEY_REUSED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 429,
  "detail": "<string>",
  "code": "BUSINESS_RATE_LIMITED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 460,
  "detail": "<string>",
  "code": "STORE_SCOPE_FORBIDDEN",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 500,
  "detail": "<string>",
  "code": "INTERNAL_ERROR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "API_BUSY",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

Data

Write a value

Writes the whole value. The key must be declared for the owner type by the installation’s version; the value must be of the declared type and at most 16,384 bytes of compact JSON; visibility comes from the declaration. An installation holds at most 50,000 values: past that a NEW key is refused, an existing one is still rewritten.

The scope depends on the owner type: business needs none; store needs the read_stores scope (permission stores:read); product needs the read_products scope (permission products:read); order needs the read_orders scope (permission orders:read); customer needs the read_customers scope (permission customers:read).

PUT

apps

2026-10

data

{ownerType}

{ownerId}

{key}

Write a value

curl --request PUT \
  --url https://api.tassyir.io/apps/2026-10/data/{ownerType}/{ownerId}/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<unknown>"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<unknown>'})
};

fetch('https://api.tassyir.io/apps/2026-10/data/{ownerType}/{ownerId}/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "<string>",
    "ownerType": "business",
    "ownerId": "<string>",
    "key": "<string>",
    "value": "<unknown>",
    "visibility": "app",
    "declared": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "<string>",
    "ownerType": "business",
    "ownerId": "<string>",
    "key": "<string>",
    "value": "<unknown>",
    "visibility": "app",
    "declared": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "APP_DATA_KEY_NOT_DECLARED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "APP_TOKEN_INVALID",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "PERMISSION_DENIED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "NOT_FOUND",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 409,
  "detail": "<string>",
  "code": "APP_DATA_LIMIT_REACHED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "PAYLOAD_TOO_LARGE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 422,
  "detail": "<string>",
  "code": "IDEMPOTENCY_KEY_REUSED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 429,
  "detail": "<string>",
  "code": "BUSINESS_RATE_LIMITED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 460,
  "detail": "<string>",
  "code": "STORE_SCOPE_FORBIDDEN",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 500,
  "detail": "<string>",
  "code": "INTERNAL_ERROR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "API_BUSY",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Headers

Idempotency-Key

string

Makes a write safe to retry: the same key with the same method, path, query and body within 24 hours answers the stored result (Idempotent-Replayed: true) without running the write again. Only a successful answer is stored, so a retry after a failure runs. A key reused for a different request is 422 IDEMPOTENCY_KEY_REUSED; one whose first request still runs is 409 IDEMPOTENCY_KEY_IN_USE.

Required string length: 1 - 255

Pattern: ^[\x21-\x7E]+$

Path Parameters

ownerType

enum<string>

required

What the value is kept on. Another word is 400 VALIDATION_FAILED.

Available options:

business,

store,

product,

order,

customer

ownerId

string

required

The owner's id (for business, the business id). An owner this installation cannot read, or a malformed id, is 404 NOT_FOUND; a store outside the installation's stores is 460 STORE_SCOPE_FORBIDDEN.

Minimum string length: 1

key

string

required

A key the manifest declares for the owner type ([[data.definitions]]). A malformed one is 400 VALIDATION_FAILED.

Pattern: ^[a-z][a-z0-9_]{0,63}$

Query Parameters

fields

string

Return only these top-level fields, separated by commas; the id is always kept. The response schema describes the whole resource. An unknown name is 400 INVALID_FIELDS. Fields: id, ownerType, ownerId, key, value, visibility, declared, createdAt, updatedAt.

Maximum string length: 1000

Body

application/json

value

any

required

A JSON value of the type the manifest declares for the key, never null.

Response

Replaced.

data

object

required

A value an app keeps on a Tassyir resource (API 2026-10).

Show child attributes

Admin API

Developer API

Write a value

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response