GUgusto
Companies

Migrate company to embedded payroll

Migrate an existing Gusto customer to your embedded payroll product.

Prerequisites

Before calling this endpoint:

  1. The customer must connect their Gusto account to your application using OAuth2
  2. The customer must view and accept the Embedded Payroll Terms of Service

Related guides

  • Migrate an existing company

scope: partner_managed_companies:write

put/v1/partner_managed_companies/{company_uuid}/migrate

Request

Path parameters

company_uuidstring required

The UUID of the company

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

PartnerManagedCompanyMigrateRequest required

Request body is optional in API version 2026-02-01 and later. The Terms of Service signer is resolved from the authenticated payroll-admin user; the previously required email, ip_address, and external_user_id parameters are no longer accepted.

Response

Success

company_uuidstring

The company UUID.

migration_statusboolean

Returns true when the migration completed successfully, false otherwise.

Changes

No recorded changes to this operation across all 2 revisions of this API.