Auto Enrichment | SalesOS Docs

Get auto-enrichment configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/auto-enrichment/config" \
  -H "Authorization: Bearer <token>"

Enrichment configuration

Update auto-enrichment configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

curl -X PATCH "https://api.salesos.org/v1/auto-enrichment/config" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Updated enrichment configuration

Update auto-enrichment configuration (PUT)

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

curl -X PUT "https://api.salesos.org/v1/auto-enrichment/config" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Updated enrichment configuration

List enrichment jobs

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

entityTypeRequiredstring

statusRequiredstring

curl -X GET "https://api.salesos.org/v1/auto-enrichment/jobs?entityType=%3Cstring%3E&status=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

List of enrichment jobs

Get enrichment job details

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X GET "https://api.salesos.org/v1/auto-enrichment/jobs/<string>" \
  -H "Authorization: Bearer <token>"

Enrichment job details

Get enrichment conflicts needing review

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/auto-enrichment/conflicts" \
  -H "Authorization: Bearer <token>"

List of conflicts

Resolve an enrichment conflict

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://api.salesos.org/v1/auto-enrichment/conflicts/<string>/resolve" \
  -H "Authorization: Bearer <token>"

Conflict resolved

Resolve an enrichment conflict (PUT)

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

idRequiredstring

curl -X PUT "https://api.salesos.org/v1/auto-enrichment/conflicts/<string>/resolve" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Conflict resolved

Get enrichment statistics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/auto-enrichment/stats" \
  -H "Authorization: Bearer <token>"

Enrichment statistics

Retry a failed enrichment job

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://api.salesos.org/v1/auto-enrichment/jobs/<string>/retry" \
  -H "Authorization: Bearer <token>"

Job queued for retry

Pause enrichment pipeline

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/auto-enrichment/pause" \
  -H "Authorization: Bearer <token>"

Pipeline paused

Resume enrichment pipeline

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/auto-enrichment/resume" \
  -H "Authorization: Bearer <token>"

Pipeline resumed

Get credit usage breakdown

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/auto-enrichment/credits" \
  -H "Authorization: Bearer <token>"

Credit usage