Skip to main content
POST
/
v1
/
tenants
/
{tenant_id}
/
subjects
/
{subject_type}
/
{subject_id}
/
updates
Propose an identity state update
curl --request POST \
  --url https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/tenants/{tenant_id}/subjects/{subject_type}/{subject_id}/updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject_id": "<string>",
  "base_snapshot_version": 123,
  "patch_ops": [
    {
      "path": "<string>",
      "value": "<unknown>"
    }
  ]
}
'
{
  "update_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject_type": "<string>",
  "subject_id": "<string>",
  "base_snapshot_version": 123,
  "status": "proposed",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Firebase Auth JWT issued by Google Identity Platform. Obtain a token by signing in at your app domain and calling firebase.auth().currentUser.getIdToken().

Path Parameters

​
tenant_id
string
required

Tenant identifier.

​
subject_type
enum<string>
required

Subject type discriminator.

Available options:
entity,
individual
​
subject_id
string
required

Stable subject identifier within its type namespace.

Body

application/json
​
subject_id
string
required
​
subject_type
enum<string>
required
Available options:
entity,
individual
​
base_snapshot_version
integer
required

The version this patch is based on. Must be the current latest.

​
patch_ops
object[]
required

RFC 6902 JSON Patch operations. Only add, replace, and remove are supported.

Response

Update proposal created.

​
update_id
string<uuid>
​
subject_type
string
​
subject_id
string
​
base_snapshot_version
integer
​
status
enum<string>
Available options:
proposed
​
created_at
string<date-time>