Silverpop Export

View as Markdown

Create and manage data import and export jobs.

SilverpopExport: Create job

POSThttps://api.lytics.io/v2/job/silverpop-export

Create a SilverpopExport job

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.add_contactsoptionalboolean

Create new contacts in Acoustic if they do not already exist

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected fields get an update, then the user will be updated in Acoustic

config.mappingsoptionalobject[]

Map additional fields from Lytics to Acoustic by selecting the Lytics field on the left, and its Acoustic destination on the right

config.recipient_idoptionalstring

Select the Lytics field that contains the Acoustic Recipient ID. Recipient ID exports will only update current users in Acoustic and will not add new users. sync_fields will be ignored if this is set

config.segment_idsrequiredstring[]

Select the Lytics audiences to export. As users enter or exit the selected audience(s) their record will be sent to Acoustic

config.silverpop_databaseoptionalinteger

Select the Acoustic database to populate

config.single_segment_empty_stringoptionalstring

Optional - set this to a value like "null" to represent an empty audience. An empty string is sent by default

config.single_segment_fieldoptionalstring

Select a field, or enter a name to create a field, to write the additional Lytics audiences to. If the field is left empty, a Yes/No field is created for each audience

config.sync_fieldsoptionalobject[]

Choose the sync fields. The sync fields are the fields that are used to match and identify users like unique id or email. At least one sync field must be specified

config.update_existingoptionalboolean

Update fields of existing contacts in Acoustic

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

Sample Request

{
  "auth_ids": [
    "string"
  ],
  "config": {
    "add_contacts": true,
    "field_changes": [
      "string"
    ],
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "recipient_id": "string",
    "segment_ids": [
      "string"
    ],
    "silverpop_database": 0,
    "single_segment_empty_string": "string",
    "single_segment_field": "string",
    "sync_fields": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "update_existing": true
  },
  "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

{
  "_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": {
      "add_contacts": true,
      "field_changes": [
        "string"
      ],
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "recipient_id": "string",
      "segment_ids": [
        "string"
      ],
      "silverpop_database": 0,
      "single_segment_empty_string": "string",
      "single_segment_field": "string",
      "sync_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "update_existing": true
    },
    "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
}

SilverpopExport: Get job

GEThttps://api.lytics.io/v2/job/silverpop-export/{id}

SilverpopExport: Update job

PUThttps://api.lytics.io/v2/job/silverpop-export/{id}

{ "auth_ids": [ "string" ], "config": { "add_contacts": true, "field_changes": [ "string" ], "mappings": [ { "property1": "string", "property2": "string" } ], "recipient_id": "string", "segment_ids": [ "string" ], "silverpop_database": 0, "single_segment_empty_string": "string", "single_segment_field": "string", "sync_fields": [ { "property1": "string", "property2": "string" } ], "update_existing": true }, "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" }

{ "_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": { "add_contacts": true, "field_changes": [ "string" ], "mappings": [ { "property1": "string", "property2": "string" } ], "recipient_id": "string", "segment_ids": [ "string" ], "silverpop_database": 0, "single_segment_empty_string": "string", "single_segment_field": "string", "sync_fields": [ { "property1": "string", "property2": "string" } ], "update_existing": true }, "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 }

Silverpop Export

SilverpopExport: Create job

Query Parameters

Headers

Body Parameters

SilverpopExport: Get job

SilverpopExport: Update job

Silverpop Export

SilverpopExport: Create job

Query Parameters

Headers

Body Parameters

SilverpopExport: Get job

SilverpopExport: Update job

URL Parameters

Query Parameters

Headers

URL Parameters

Query Parameters

Headers

Body Parameters

URL Parameters

Query Parameters

Headers

URL Parameters

Query Parameters

Headers

Body Parameters