Which guide do you need?
Look at the paths that your integration calls. If they start with/v2/, use the v2 guide. If they start with /v1/, use the v1 guide. If they start with /v0/, use the v0 guide.
Migrate from Export API v2 to v3
For integrations on
/v2/. Change the version in the path. The payload has the same structure and v3 adds fields.Migrate from Export API v1 to v3
For integrations on
/v1/. Skip v2 and go directly to v3. The payload structure changes, so check your parsing.Migrate from Export API v0 to v3
For integrations on
/v0/. Skip v1 and v2 and go directly to v3. The payload structure changes, so check your parsing.What changes in v3
- The version number in the path changes to
/v3/. - The Export Item has more data. You can ignore the extra fields.
- Contra accounts are new in v3. You must map them before you can create an Export Job. See How to Resolve MISSING_CONTRA_ACCOUNTS.
- The
teamCodefield is removed. Useteam.codeinstead. - Fields that listed fixed values in v0, v1 and v2 are plain strings in v3. Your integration must not fail on a value that it does not know.
FAQs
Which Export API migration guide do I use?
Look at the path that your integration calls.
- If it starts with
/v2/, use Migrate from Export API v2 to v3. - If it starts with
/v1/, use Migrate from Export API v1 to v3. - If it starts with
/v0/, use Migrate from Export API v0 to v3.
What changes in every version of the migration?
Make these changes in every guide:
- Change the version in the path to
/v3/. - Replace the
statusquery parameter ofGET /v3/export-jobswithstatuses. - Replace
teamCodewithteam.code. - Ignore fields that you do not know, and accept values that you do not know for fields such as
type,statusandfailureReasonType. - Map contra accounts before you create an Export Job.