Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Versium Enrich

Versium Enrich

markdownView as Markdown

Create and manage data import and export jobs.

VersiumEnrich: Create job

POSThttps://api.lytics.io/v2/job/versium-enrich

Create a VersiumEnrich job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "address_field": "string",
    "business_address_field": "string",
    "business_city_field": "string",
    "business_name_field": "string",
    "business_phone_field": "string",
    "business_state_field": "string",
    "business_zip_field": "string",
    "city_field": "string",
    "domain_field": "string",
    "email_field": "string",
    "enrichment_tools": [
      "string"
    ],
    "firstname_field": "string",
    "fullname_field": "string",
    "ip_address_field": "string",
    "lastname_field": "string",
    "phone_field": "string",
    "reenrich": true,
    "segment_id": "string",
    "state_field": "string",
    "withbackfill": true,
    "zip_field": "string"
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "address_field": "string",
      "business_address_field": "string",
      "business_city_field": "string",
      "business_name_field": "string",
      "business_phone_field": "string",
      "business_state_field": "string",
      "business_zip_field": "string",
      "city_field": "string",
      "domain_field": "string",
      "email_field": "string",
      "enrichment_tools": [
        "string"
      ],
      "firstname_field": "string",
      "fullname_field": "string",
      "ip_address_field": "string",
      "lastname_field": "string",
      "phone_field": "string",
      "reenrich": true,
      "segment_id": "string",
      "state_field": "string",
      "withbackfill": true,
      "zip_field": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

VersiumEnrich: Get job

GEThttps://api.lytics.io/v2/job/versium-enrich/{id}

Get the summary of a VersiumEnrich job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "address_field": "string",
      "business_address_field": "string",
      "business_city_field": "string",
      "business_name_field": "string",
      "business_phone_field": "string",
      "business_state_field": "string",
      "business_zip_field": "string",
      "city_field": "string",
      "domain_field": "string",
      "email_field": "string",
      "enrichment_tools": [
        "string"
      ],
      "firstname_field": "string",
      "fullname_field": "string",
      "ip_address_field": "string",
      "lastname_field": "string",
      "phone_field": "string",
      "reenrich": true,
      "segment_id": "string",
      "state_field": "string",
      "withbackfill": true,
      "zip_field": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

VersiumEnrich: Update job

PUThttps://api.lytics.io/v2/job/versium-enrich/{id}

Update a VersiumEnrich job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "address_field": "string",
    "business_address_field": "string",
    "business_city_field": "string",
    "business_name_field": "string",
    "business_phone_field": "string",
    "business_state_field": "string",
    "business_zip_field": "string",
    "city_field": "string",
    "domain_field": "string",
    "email_field": "string",
    "enrichment_tools": [
      "string"
    ],
    "firstname_field": "string",
    "fullname_field": "string",
    "ip_address_field": "string",
    "lastname_field": "string",
    "phone_field": "string",
    "reenrich": true,
    "segment_id": "string",
    "state_field": "string",
    "withbackfill": true,
    "zip_field": "string"
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "address_field": "string",
      "business_address_field": "string",
      "business_city_field": "string",
      "business_name_field": "string",
      "business_phone_field": "string",
      "business_state_field": "string",
      "business_zip_field": "string",
      "city_field": "string",
      "domain_field": "string",
      "email_field": "string",
      "enrichment_tools": [
        "string"
      ],
      "firstname_field": "string",
      "fullname_field": "string",
      "ip_address_field": "string",
      "lastname_field": "string",
      "phone_field": "string",
      "reenrich": true,
      "segment_id": "string",
      "state_field": "string",
      "withbackfill": true,
      "zip_field": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.address_fieldoptionalstring

The field name that contains the user's address

config.business_address_fieldoptionalstring

The field name that contains the user's company address

config.business_city_fieldoptionalstring

The field name that contains the user's company city

config.business_name_fieldoptionalstring

The field name that contains the user's company name

config.business_phone_fieldoptionalstring

The field name that contains the user's company phone number

config.business_state_fieldoptionalstring

The field name that contains the user's company state

config.business_zip_fieldoptionalstring

The field name that contains the user's company zip

config.city_fieldoptionalstring

The field name that contains the user's city

config.domain_fieldoptionalstring

The field name that contains the user's company domain

config.email_fieldoptionalstring

The field name that contains the user's email

config.enrichment_toolsoptionalstring[]

Select the Versium Enrichment tools to use

config.firstname_fieldoptionalstring

The field name that contains the user's first name

config.fullname_fieldoptionalstring

The field name that contains the user's full name

config.ip_address_fieldoptionalstring

The field name that contains the user's IP address

config.lastname_fieldoptionalstring

The field name that contains the user's last name

config.phone_fieldoptionalstring

The field name that contains the user's phone number

config.reenrichoptionalboolean

Select this to force enrich all users. By default users who have been enriched in the past 30 days through Versium will not be enriched

config.segment_idoptionalstring

The name of the Lytics audience that contains the users to enrich

config.state_fieldoptionalstring

The field name that contains the user's state

config.withbackfilloptionalboolean

Enrich users who already exist in the selected audience

config.zip_fieldoptionalstring

The field name that contains the user's zip code

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.address_fieldoptionalstring

The field name that contains the user's address

config.business_address_fieldoptionalstring

The field name that contains the user's company address

config.business_city_fieldoptionalstring

The field name that contains the user's company city

config.business_name_fieldoptionalstring

The field name that contains the user's company name

config.business_phone_fieldoptionalstring

The field name that contains the user's company phone number

config.business_state_fieldoptionalstring

The field name that contains the user's company state

config.business_zip_fieldoptionalstring

The field name that contains the user's company zip

config.city_fieldoptionalstring

The field name that contains the user's city

config.domain_fieldoptionalstring

The field name that contains the user's company domain

config.email_fieldoptionalstring

The field name that contains the user's email

config.enrichment_toolsoptionalstring[]

Select the Versium Enrichment tools to use

config.firstname_fieldoptionalstring

The field name that contains the user's first name

config.fullname_fieldoptionalstring

The field name that contains the user's full name

config.ip_address_fieldoptionalstring

The field name that contains the user's IP address

config.lastname_fieldoptionalstring

The field name that contains the user's last name

config.phone_fieldoptionalstring

The field name that contains the user's phone number

config.reenrichoptionalboolean

Select this to force enrich all users. By default users who have been enriched in the past 30 days through Versium will not be enriched

config.segment_idoptionalstring

The name of the Lytics audience that contains the users to enrich

config.state_fieldoptionalstring

The field name that contains the user's state

config.withbackfilloptionalboolean

Enrich users who already exist in the selected audience

config.zip_fieldoptionalstring

The field name that contains the user's zip code

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring