Update Sync Job Run State

---

Update the value of an existing sync job run state.

Endpoint

PATCH /sync-job-run-state/{id}

Path parameters

id

string

REQUIRED · 

The ID of the state to update.

Example: last_processed_id

Query parameters

Refer Specifying query parameters in Truto APIs

state_key

string

REQUIRED · 

The state_key attribute found in a sync job run and defined in the sync job. Used as a namespace for the states.

Example: sync_job_123

Request Body

value

string

The new state value to store.

Example: eyJpZCI6IjY3ODkwIiwidGltZXN0YW1wIjoiMjAyMy0wMi0wMVQwMDowMDowMFoifQ==

Response Body

key

string

Key for this state entry. Unique within the namespace identified by state_key.

Example: last_processed_id

value

string

The stored value. Encode structured data (for example, JSON) as a string before storing.

Example: eyJpZCI6IjEyMzQ1IiwidGltZXN0YW1wIjoiMjAyMy0wMS0wMVQwMDowMDowMFoifQ==

sync_job_run_id

string · uuid

The ID of the sync job run that wrote this entry, if any.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7

created_at

string · date-time

Time at which the state entry was first created.

Example: 2023-01-01T10:00:00.000Z

updated_at

string · date-time

Time at which the state entry was last updated.

Example: 2023-01-02T10:00:00.000Z