Submit Contacts for Scoring

cURL

curl --request POST \
  --url https://app.titanx.io/api/contacts/score \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "phone2": "<string>",
      "phone3": "<string>",
      "phone4": "<string>",
      "phone5": "<string>",
      "phoneExt": "<string>",
      "street": "<string>",
      "city": "<string>",
      "stateProvince": "<string>",
      "zipPostalCode": "<string>",
      "country": "<string>",
      "title": "<string>",
      "companyAccount": "<string>",
      "website": "<string>",
      "linkedInUrl": "<string>",
      "companyLinkedInUrl": "<string>",
      "persona": "<string>",
      "dept": "<string>",
      "level": "<string>",
      "jobFunction": "<string>",
      "timeZone": "<string>",
      "companyCountry": "<string>",
      "companyState": "<string>",
      "companyCity": "<string>",
      "companyZip": "<string>",
      "companyAddress": "<string>",
      "numberOfEmployees": 123,
      "annualRevenue": 123,
      "industry": "<string>",
      "primarySubIndustry": "<string>",
      "sicCodes": "<string>",
      "naicsCodes": "<string>",
      "technologies": "<string>",
      "recordOwner": "<string>",
      "contactCrmId": "<string>",
      "accountCrmId": "<string>",
      "databaseContactId": "<string>",
      "databaseCompanyId": "<string>",
      "campaignListName": "<string>",
      "callbackUrl": "<string>"
    }
  ]
}'

{
  "data": {
    "totalRecordCount": 123,
    "duplicateCount": 123,
    "acceptedRecordCount": 123,
    "jobId": "<string>"
  },
  "error": {
    "rejectedRecordCount": 123,
    "records": [
      {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "phone2": "<string>",
        "phone3": "<string>",
        "phone4": "<string>",
        "phone5": "<string>",
        "phoneExt": "<string>",
        "street": "<string>",
        "city": "<string>",
        "stateProvince": "<string>",
        "zipPostalCode": "<string>",
        "country": "<string>",
        "title": "<string>",
        "companyAccount": "<string>",
        "website": "<string>",
        "linkedInUrl": "<string>",
        "companyLinkedInUrl": "<string>",
        "persona": "<string>",
        "dept": "<string>",
        "level": "<string>",
        "jobFunction": "<string>",
        "timeZone": "<string>",
        "companyCountry": "<string>",
        "companyState": "<string>",
        "companyCity": "<string>",
        "companyZip": "<string>",
        "companyAddress": "<string>",
        "numberOfEmployees": 123,
        "annualRevenue": 123,
        "industry": "<string>",
        "primarySubIndustry": "<string>",
        "sicCodes": "<string>",
        "naicsCodes": "<string>",
        "technologies": "<string>",
        "recordOwner": "<string>",
        "contactCrmId": "<string>",
        "accountCrmId": "<string>",
        "databaseContactId": "<string>",
        "databaseCompanyId": "<string>",
        "campaignListName": "<string>",
        "callbackUrl": "<string>",
        "rejectedReason": "<string>"
      }
    ]
  }
}

POST

api

contacts

score

cURL

curl --request POST \
  --url https://app.titanx.io/api/contacts/score \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "phone2": "<string>",
      "phone3": "<string>",
      "phone4": "<string>",
      "phone5": "<string>",
      "phoneExt": "<string>",
      "street": "<string>",
      "city": "<string>",
      "stateProvince": "<string>",
      "zipPostalCode": "<string>",
      "country": "<string>",
      "title": "<string>",
      "companyAccount": "<string>",
      "website": "<string>",
      "linkedInUrl": "<string>",
      "companyLinkedInUrl": "<string>",
      "persona": "<string>",
      "dept": "<string>",
      "level": "<string>",
      "jobFunction": "<string>",
      "timeZone": "<string>",
      "companyCountry": "<string>",
      "companyState": "<string>",
      "companyCity": "<string>",
      "companyZip": "<string>",
      "companyAddress": "<string>",
      "numberOfEmployees": 123,
      "annualRevenue": 123,
      "industry": "<string>",
      "primarySubIndustry": "<string>",
      "sicCodes": "<string>",
      "naicsCodes": "<string>",
      "technologies": "<string>",
      "recordOwner": "<string>",
      "contactCrmId": "<string>",
      "accountCrmId": "<string>",
      "databaseContactId": "<string>",
      "databaseCompanyId": "<string>",
      "campaignListName": "<string>",
      "callbackUrl": "<string>"
    }
  ]
}'

{
  "data": {
    "totalRecordCount": 123,
    "duplicateCount": 123,
    "acceptedRecordCount": 123,
    "jobId": "<string>"
  },
  "error": {
    "rejectedRecordCount": 123,
    "records": [
      {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "phone2": "<string>",
        "phone3": "<string>",
        "phone4": "<string>",
        "phone5": "<string>",
        "phoneExt": "<string>",
        "street": "<string>",
        "city": "<string>",
        "stateProvince": "<string>",
        "zipPostalCode": "<string>",
        "country": "<string>",
        "title": "<string>",
        "companyAccount": "<string>",
        "website": "<string>",
        "linkedInUrl": "<string>",
        "companyLinkedInUrl": "<string>",
        "persona": "<string>",
        "dept": "<string>",
        "level": "<string>",
        "jobFunction": "<string>",
        "timeZone": "<string>",
        "companyCountry": "<string>",
        "companyState": "<string>",
        "companyCity": "<string>",
        "companyZip": "<string>",
        "companyAddress": "<string>",
        "numberOfEmployees": 123,
        "annualRevenue": 123,
        "industry": "<string>",
        "primarySubIndustry": "<string>",
        "sicCodes": "<string>",
        "naicsCodes": "<string>",
        "technologies": "<string>",
        "recordOwner": "<string>",
        "contactCrmId": "<string>",
        "accountCrmId": "<string>",
        "databaseContactId": "<string>",
        "databaseCompanyId": "<string>",
        "campaignListName": "<string>",
        "callbackUrl": "<string>",
        "rejectedReason": "<string>"
      }
    ]
  }
}

Scoring is not instant and can take up to 24 hours to complete. In order to receive your scored data you must provide a callbackURL. See Scoring for more information.

Callback response

Once a contact is scored, the callback URL you provide will receive a response with one or more contacts of the following fields:

contact

PrlContact Object

Show properties

leadStatus

LeadStatus

The lead status of the contact

firstName

string

The first name of the contact

lastName

string

The last name of the contact

string

The email address of the contact

phone

string

The primary phone number of the contact

phoneStatus

PhoneStatus

The status of the phone number

phone2

string

An additional phone number for the contact

phone2Status

PhoneStatus

The status of the phone2 number

phone3

string

An additional phone number for the contact

phone3Status

PhoneStatus

The status of the phone3 number

phone4

string

An additional phone number for the contact

phone4Status

PhoneStatus

The status of the phone4 number

phone5

string

An additional phone number for the contact

phone5Status

PhoneStatus

The status of the phone5 number

phoneExt

string

The phone extension for the contact

street

string

The street address of the contact

city

string

The city of the contact

stateProvince

string

The state or province of the contact

zipPostalCode

string

The zip or postal code of the contact

country

string

The country of the contact

title

string

The job title of the contact

companyAccount

string

The company account associated with the contact

website

string

The website of the contact’s company

linkedInUrl

string

The LinkedIn URL of the contact

companyLinkedInUrl

string

The LinkedIn URL of the contact’s company

persona

string

The persona of the contact

dept

string

The department of the contact

level

string

The level of the contact within their organization

jobFunction

string

The job function of the contact

timeZone

string

The time zone of the contact

companyCountry

string

The country of the contact’s company

companyState

string

The state of the contact’s company

companyCity

string

The city of the contact’s company

companyZip

string

The zip code of the contact’s company

companyAddress

string

The address of the contact’s company

numberOfEmployees

number

The number of employees in the contact’s company

annualRevenue

number

The annual revenue of the contact’s company

industry

string

The industry of the contact’s company

primarySubIndustry

string

The primary sub-industry of the contact’s company

sicCodes

string

The SIC codes associated with the contact’s company

naicsCodes

string

The NAICS codes associated with the contact’s company

technologies

string

The technologies used by the contact’s company

recordOwner

string

The owner of the contact record

contactCrmId

string

The CRM ID of the contact

accountCrmId

string

The CRM ID of the contact’s account

databaseContactId

string

The database ID of the contact

databaseCompanyId

string

The database ID of the contact’s company

campaignListName

string

The name of the campaign list associated with the contact

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200 - application/json

Successful response

The response is of type object.

Enrichment (Coming Soon!)

Contact Data

Jobs

Submit Contacts for Scoring

Callback response

Authorizations

Body

Response

Contact Data

Jobs

​Callback response

Authorizations

Body

Response

Callback response