Start a CRM Import

This tutorial walks you through kicking off a CRM Import: sending DealHub the list of buyer-account CRM ids you want migrated, and handling the response.

Before You Begin

To follow this tutorial, make sure you have:

• A DealHub authentication token generated by your CPQ administrator. Unlike the CRM Integration API, this token is a standing Bearer token, there's no separate one-time-access-token exchange, and the tenant is resolved from the token itself.
• The list of buyer-account CRM ids you want to migrate (from Salesforce, HubSpot, or Microsoft Dynamics, whichever CRM the tenant is connected to).

Step 1: Construct the JSON Payload

Build a JSON object containing the buyer-account CRM ids to import. Duplicate ids are removed automatically, so you don't need to de-duplicate the list yourself.

{
  "buyer_account_crm_ids": ["0011t00000ABCDE", "0011t00000FGHIJ"]
}

Step 2: Send the API Request

Send a POST request to the Start CRM Import endpoint with your JSON payload.

• Endpoint: /api/v1/accounts/crm-import
• Headers:
  • Authorization: Bearer <TOKEN_THAT_WAS_PROVIDED_BY_CPQ_ADMIN>
  • Content-Type: application/json

Step 3: Handle the Response

A successful request returns a 200 OK status and a request_id for the import:

{
  "request_id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
}

Save this request_id. You'll use it to poll progress, drill into per-account/contact detail, look up a specific id, or retry failures.

Next Steps

Now that you've started an import, learn how to track its progress.