Contact Exporters

This object allows you to create custom Contact Exporters. The Contact Exporter defines how and where the contacts generated by the Campaign are delivered.

Create contact exporter

Create a new Contact Exporter by defining the contact matching criteria and the exportable columns. If desired, designate an SFTP setting and/or screen through Compliance Guard.

When contacts are screened, the exporter calls Compliance Guard with the checkAtCompanyNoon flag enabled (see checkAtCompanyNoon for further information). In other words, regardless of the time of day that the exporter runs, compliance is checked as of noon in the company’s time zone. This does not override other reasons a check can fail: the borrower having a Do Not Interact in place, having reached the interaction frequency limit, etc.

Where possible, it’s always advised to check compliance right before an action. Many things can change (payments are made, other automated interactions are sent, consents/addresses can be updated) from when you plan something to happen to when it actually happens. Lenders are responsible for ensuring it is still permissible to conduct the interaction.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
object

Settings for selecting a person’s contact information to include in export data. An empty attribute is not allowed. Multiple attributes act as “AND” filters. E.g., a contact must have an affiliation of “self” AND a label of “home” in order to match. If multiple values are specified for an attribute, the values act as “OR” conditions within that attribute.

Array of objects

A list of dictionaries where each dictionary specifies a field to include as a column in the result file along with optional output column name.

object or null

If set, screen contacts through Compliance Guard using provided data.

Responses
200

success

post/campaign-workers/contact-exporters
Request samples
application/json
{
  • "contactMatchingCriteria": {
    },
  • "columnSettings": [
    ],
  • "checkCanInteractData": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

List contact exporters

Get a list of all contact exporters.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
sortBy
Array of strings

The data attributes by which to sort the results.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

Responses
200

success

get/campaign-workers/contact-exporters
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Get contact exporter by ID

Get a contact exporter by ID.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
contactExporterId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The contactExporter object unique identifier.

Responses
200

success

get/campaign-workers/contact-exporters/{contactExporterId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update contact exporter

Update a contact exporter by ID.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
contactExporterId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The contactExporter object unique identifier.

Request Body schema: application/json
object

Settings for selecting a person’s contact information to include in export data. An empty attribute is not allowed. Multiple attributes act as “AND” filters. E.g., a contact must have an affiliation of “self” AND a label of “home” in order to match. If multiple values are specified for an attribute, the values act as “OR” conditions within that attribute.

Array of objects

A list of dictionaries where each dictionary specifies a field to include as a column in the result file along with optional output column name.

object or null

If set, screen contacts through Compliance Guard using provided data.

Responses
200

success

put/campaign-workers/contact-exporters/{contactExporterId}
Request samples
application/json
{
  • "contactMatchingCriteria": {
    },
  • "columnSettings": [
    ],
  • "checkCanInteractData": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete contact exporter

Delete a contact exporter by ID.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
contactExporterId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The contactExporter object unique identifier.

Responses
200

Success

delete/campaign-workers/contact-exporters/{contactExporterId}