Create Enrich CRM Record Job

Trigger an asynchronous job that enriches the CRM record behind a connection. Only the primary (data-exchange) connection can be enriched; targeting a non-primary connection returns 422. The remote_type is inferred from the connection record. Check enrichment_available on the connection before calling. The job runs in the background; poll GET /v1/enrich-crm-record-jobs/{job_id} and, once it completes, fetch the enriched record via the matching CRM record endpoint using result.crm_record.id.

Credit Note: Enriching a CRM record consumes 1 credit, unless the company or contact was already accessed within the last 12 months. The job's credits reports the charge.

INFO

Requires the crm_records:write OAuth2 scope.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Body Params application/jsonRequired

Example

{
    "data": {
        "attributes": {
            "crm_connection_id": "42_159001425_9f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
        },
        "type": "enrich_crm_record_job"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

Job accepted and started

Bodyapplication/json

Example

{
    "data": {
        "attributes": {
            "completed_at": null,
            "configuration": {
                "crm_connection_id": "42_159001425_9f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
            },
            "created_at": "2026-09-23T12:00:00Z",
            "errors": [],
            "status": "running"
        },
        "id": "job_550e8400-e29b-41d4-a716-446655440000",
        "type": "enrich_crm_record_job"
    },
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

🟠429

🔴500Server Error

🔴504Gateway Timeout