Update Migration

PATCH /api/v1/payroll-migrations/{id}/

Update the details of an existing payroll migration. Only the fields you include in the request body will be updated.

Authentication

Requires an API key with migrations:write scope. Pass via the X-API-Key header.

Path Parameters

Parameter	Type	Description
`id`	string (UUID)	The unique identifier of the migration.

Request

Content type: application/json

Body Parameters

Field	Type	Required	Description
`name`	string	No	Updated name for the migration.
`source_provider`	string	No	Updated source provider identifier.
`target_provider`	string	No	Updated target provider identifier.

Response

Status: 200 OK

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "name": "Q1 2026 ADP to Gusto Migration (Updated)",
  "source_provider": "adp",
  "target_provider": "gusto",
  "status": "pending",
  "organization": "org_abc123",
  "created_at": "2026-03-16T12:00:00Z",
  "updated_at": "2026-03-16T14:30:00Z"
}

Errors

Status	Description
`400`	Invalid request body fields.
`401`	Missing or invalid API key.
`403`	API key does not have `migrations:write` scope.
`404`	Migration not found.

Code Examples

curl -X PATCH https://api.parsifyhq.com/api/v1/payroll-migrations/b2c3d4e5-f6a7-8901-bcde-f12345678901/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Q1 2026 ADP to Gusto Migration (Updated)"}'

import requests
 
migration_id = "b2c3d4e5-f6a7-8901-bcde-f12345678901"
 
resp = requests.patch(
    f"https://api.parsifyhq.com/api/v1/payroll-migrations/{migration_id}/",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={"name": "Q1 2026 ADP to Gusto Migration (Updated)"},
)
 
print(resp.json())

const migrationId = "b2c3d4e5-f6a7-8901-bcde-f12345678901";
 
const resp = await fetch(
  `https://api.parsifyhq.com/api/v1/payroll-migrations/${migrationId}/`,
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ name: "Q1 2026 ADP to Gusto Migration (Updated)" }),
  }
);
 
const data = await resp.json();

Retrieve Migration Create Run