Integrations > SyncRunOutput

Creates a Sync run output

Changed on

Creates a Sync run output

post/api/2026-10-01/resources/integrations/sync_run_outputs

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/integrations/sync_run_outputs
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token
    • or API key in header x-api-key

Request body multipart/form-data

sync_run_idstring required

Identifier of the sync run this output belongs to

filestring binary required

The CSV file to upload as the sync run output

file_namestring required

Optional custom name for the uploaded file. When omitted, a standardized name is generated.

Example request

{
  "sync_run_id": "1",
  "file_name": "my_custom_export.csv"
}

Response

CREATED

idstring required

Identifier of the sync run output

sync_run_idstring required

Identifier of the sync run this output belongs to

file_namestring required

Name of the uploaded file

created_atstring required

Timestamp when the sync run output was created

Example response

{
  "id": "1",
  "sync_run_id": "1",
  "file_name": "202502011430_factorial_demo_file_compensations_20250101_20250131.csv",
  "created_at": "2024-01-20T18:05:45.000Z"
}

Changes