SAsalesstream
Jobs

Create a job from an uploaded file

post/v1/jobs

Request

  • Base URL
    https://dataapi.reachthepeople.ai/api
  • Auth
    HTTP bearer

Request body

type'email_append' required

What to append to each matched record

namestring required
fileRefstring required

fileRef from POST /v1/files

filenamestring required
delimiter'comma' | 'tab' | 'pipe' | 'semicolon'

Column delimiter of the uploaded file (the literal character is also accepted)

hasRowHeaderboolean
columnsobject required

Map of your file's columns to identity fields, as { fieldName: columnNumber } (1-based). Recognized fields: title, firstName, middleName, lastName, suffix, fullName, birthdate, address, addressLine2, city, state, zip, zip4, email, phone, mobile. Must include lastName, an address (address / fullAddress / houseNumber), and a zip (zip or zip4) so records can be matched.

emailValidation'none' | 'blank' | 'indicator'

email_append only: how appended emails are validated

notificationEmailstring

Optional email address to notify when the job completes

Example request

{
  "name": "June email append",
  "filename": "contacts.csv",
  "columns": {
    "firstName": 2,
    "lastName": 4,
    "address": 5,
    "city": 7,
    "state": 8,
    "zip": 9,
    "zip4": 10
  },
  "notificationEmail": "ops@example.com"
}

Response

Job created

jobIdstring
statusstring

Example response

{
  "status": "Created"
}

Changes

No recorded changes to this operation across all 1 revision of this API.