Skip to content

inviteMIUser ​

Allows an authenticated NI/MI user to invite a Contact to their Company wall. Normally used by NI reps but could be used with MI too

Request ​

http
POST /rest/user/miinvite

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

The following type of request should be posted as the body. NOTE: for "contact" only "firstname", "lastname", and "email1" fields are required but any other fields can be passed. If an existing contact is found, it will use the current SAM details i.e. you cannot update contact details using this service.

json
{
  "companyId": 3,
  "contact": {
    "contactId": null,
    "countryCode": null,
    "firstname": "Doctor Invited By Rep",
    "lastname": "McMullen",
    "department": null,
    "company": null,
    "workAddress1": null,
    "workAddress2": null,
    "city": null,
    "state": null,
    "postCode": null,
    "otherCountryCode": null,
    "externalId": null,
    "contactType": null,
    "title": null,
    "mobile": null,
    "phone": null,
    "otherPhone": null,
    "contactProfession": null,
    "contactSpecialty": null,
    "contactCategory": null,
    "email1": "aaron@interact.technology",
    "email2": null,
    "workAddress3": null,
    "ownedBy": null,
    "notes": null,
    "facebookId": null,
    "dateOfBirth": null,
    "webPage": null,
    "otherAddress1": null,
    "otherAddress2": null,
    "otherAddress3": null,
    "otherCity": null,
    "otherState": null,
    "otherPostcode": null,
    "faxNumber": null,
    "twitterId": null
  },
  "inviteTeams": [
    {
      "teamId": 22,
      "teamName": "Equity Investments"
    },
    {
      "teamId": 21,
      "teamName": "Property Investments"
    }
  ]
}

Response ​

200 OK ​

JSON Reponse:

json
{
"errorCode": 0,
"errorMsg": "MI User invited."
}

Errors ​

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