Skip to content

preregisterContact ​

Pre-registers a contact into a particular Company (NI or MI). All exisitng CONTACT fields can be used in the request BUT email, firstname, and lastname are mandatory.

Request ​

http
POST /rest/company/mi/preregister

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

A JSON request in format below. Mandatory feilds are version, preRegCompanyKey, as well as contactDetails fields email1, firstname, and lastname. Only version 1 supported as of 2016-08-29. preRegCompanyKey is the unique Pre Reg URL defined for the company in SAM.

json
{
  "version": 1,
  "preRegCompanyKey": "myinteractfinance",
  "contactDetails": {
    "contactId": null,
    "countryCode": null,
    "otherCountryCode": null,
    "contactType": null,
    "contactProfession": null,
    "contactSpecialty": null,
    "contactCategory": null,
    "sampleOrderEmail": null,
    "contactCreated": null,
    "contactCreatedBy": null,
    "contactModified": null,
    "contactModifiedBy": null,
    "externalId": null,
    "title": null,
    "firstname": "Aaron",
    "lastname": "PreReg WebService",
    "mobile": null,
    "phone": null,
    "otherPhone": null,
    "department": null,
    "email1": "aaron+prereg-webservice@interact.technology",
    "email2": null,
    "company": null,
    "workAddress1": null,
    "workAddress2": null,
    "workAddress3": null,
    "city": null,
    "state": null,
    "postCode": null,
    "ownedBy": null,
    "notes": "I would like a follow-up call on drug X please.",
    "facebookId": null,
    "dateOfBirth": null,
    "webPage": null,
    "otherAddress1": null,
    "otherAddress2": null,
    "otherAddress3": null,
    "otherCity": null,
    "otherState": null,
    "otherPostcode": null,
    "faxNumber": null,
    "twitterId": null
  }
}

Response ​

200 OK ​

No body is returned. HTTP 200 indicatss success otherwise one of the WS* exceptions below are thrown.

Errors ​

ExceptionDescription
WSUserServiceUnavailableExceptionSee Error Definitions
WSCompanyServiceUnavailableExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSCompanyServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions