Member extra data and custom fields

Use grouped operations for group and field names you define. Use custom-fields operations for the reserved custom_fields group. Both use the same member/resource extra-data table. They do not read/write the dynamic user.extra relationship object or Firestore automatically. Values use string storage; choose a stable group/key convention in your integration.

Member and storage context

Use the resolved member and their existing relationship to the selected resource. User ACL and shared resource, session and account restrictions apply. Send the Wallkit session in token and resource public key in resource. Firebase-enabled members also supply the matching ID token in firebase-token; omit that header for an ordinary integration.

Examples use synthetic member 42 in resource 1001. The extra-data row definition describes storage and input limits; sample runtimes describe the clients. Read stored fields after a change to detect skipped inputs.

Operations

curl -X GET "${WALLKIT_API_BASE}/api/v1/user/extra/data" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/extra/data", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "GET",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/user/extra/data')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN']}, method='GET')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "items": {
    "preferences": [
      {
        "id": 9001,
        "user_id": 42,
        "resource_id": 1001,
        "group_key": "preferences",
        "field_key": "music_style",
        "field_value": "techno",
        "created_at": "2030-01-01 00:00:00",
        "updated_at": "2030-01-01 00:00:00"
      }
    ]
  }
}

{
  "items": []
}

curl -X PUT "${WALLKIT_API_BASE}/api/v1/user/extra/data" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{"extra_groups":[{"group_key":"preferences","field_key":"music_style","field_value":"techno"}]}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/extra/data", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "PUT",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"extra_groups":[{"group_key":"preferences","field_key":"music_style","field_value":"techno"}]})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/user/extra/data')
body = {'extra_groups': [{'group_key': 'preferences', 'field_key': 'music_style', 'field_value': 'techno'}]}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN'], "Content-Type": "application/json"}, method='PUT')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "items": {
    "preferences": [
      {
        "id": 9001,
        "user_id": 42,
        "resource_id": 1001,
        "group_key": "preferences",
        "field_key": "music_style",
        "field_value": "techno",
        "created_at": "2030-01-01 00:00:00",
        "updated_at": "2030-01-01 00:00:00"
      }
    ]
  }
}

{
  "error": "incorrect_data",
  "error_description": "Empty user extra groups data"
}

curl -X DELETE "${WALLKIT_API_BASE}/api/v1/user/extra/data" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{"extra_groups":[{"group_key":"preferences","field_key":"music_style"}]}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/extra/data", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "DELETE",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"extra_groups":[{"group_key":"preferences","field_key":"music_style"}]})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/user/extra/data')
body = {'extra_groups': [{'group_key': 'preferences', 'field_key': 'music_style'}]}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN'], "Content-Type": "application/json"}, method='DELETE')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{}

{
  "error": "incorrect_data",
  "error_description": "Empty user extra groups data"
}

curl -X GET "${WALLKIT_API_BASE}/api/v1/user/extra/data/custom-fields" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/extra/data/custom-fields", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "GET",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/user/extra/data/custom-fields')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN']}, method='GET')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "items": [
    {
      "id": 9001,
      "user_id": 42,
      "resource_id": 1001,
      "group_key": "custom_fields",
      "field_key": "music_style",
      "field_value": "techno",
      "created_at": "2030-01-01 00:00:00",
      "updated_at": "2030-01-01 00:00:00"
    }
  ]
}

{
  "items": []
}

curl -X PUT "${WALLKIT_API_BASE}/api/v1/user/extra/data/custom-fields" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{"items":[{"field_key":"music_style","field_value":"techno"}]}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/extra/data/custom-fields", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "PUT",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"items":[{"field_key":"music_style","field_value":"techno"}]})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/user/extra/data/custom-fields')
body = {'items': [{'field_key': 'music_style', 'field_value': 'techno'}]}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN'], "Content-Type": "application/json"}, method='PUT')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "items": [
    {
      "id": 9001,
      "user_id": 42,
      "resource_id": 1001,
      "group_key": "custom_fields",
      "field_key": "music_style",
      "field_value": "techno",
      "created_at": "2030-01-01 00:00:00",
      "updated_at": "2030-01-01 00:00:00"
    }
  ]
}

{
  "error": "field_items_required",
  "error_description": "Field items is required"
}

curl -X DELETE "${WALLKIT_API_BASE}/api/v1/user/extra/data/custom-fields/music_style" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/extra/data/custom-fields/music_style", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "DELETE",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/user/extra/data/custom-fields/music_style')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN']}, method='DELETE')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "success": true
}

{
  "error": "incorrect_field_key",
  "error_description": "Incorrect field key"
}