v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Integrations > SyncableSyncRun

Updates a Syncable sync run

put/api/2026-07-01/resources/integrations/syncable_sync_runs/{id}

Path parameters

idstring required

Identifier of the syncable sync run

Request body

idstring required

Identifier of the syncable sync run

status'success' | 'failed' | 'invalid' required

Status of the syncable sync run

error_messagesobject

Error or validation messages of the syncable sync run

Example request

{
  "id": "1",
  "status": "failed",
  "error_messages": {
    "sync_api_error": "Api sync error",
    "sync_validation_error": "Missing payroll concept code"
  }
}

Response

idstring required

Identifier of the syncable sync run

status'success' | 'failed' | 'invalid' required

Status of the syncable sync run

sync_run_idstring required

Identifier of the sync run

company_idstring required

Identifier of the company

Example response

{
  "id": "1",
  "status": "failed",
  "error_messages": [
    {
      "key": "sync_api_error",
      "value": "Api sync error"
    },
    {
      "key": "sync_validation_error",
      "value": "Missing payroll concept code"
    }
  ],
  "sync_run_id": "1",
  "company_id": "1"
}