Creating a work info

The API provides the feature to create a new work information for an Individual, in order to create a work info pass the contact id as related to Id, job title and other information as request body, AddOrganizationAsContact indicates creating new organization in case not exist, set it to false will just add information to this job title but will not create an organization.

Request Information

Body Parameters

Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.

pass the workinformation to add

NameDescriptionTypeAdditional information
OrganizationName

The Name of this Organization

string

None.

WebsiteUrl

Website URL of the Organization

string

String length: inclusive between 0 and 510

NoOfEmployees

No. of Employees in the Organization

integer

None.

Email

Email

string

None.

Fax

Fax

string

None.

Phone

Phone

string

None.

State

State Abbrevation

string

None.

Zip

Zip

string

None.

AddressLine1

Address Line 1

string

None.

AddressLine2

string

None.

AddressLine3

string

None.

AddressLine4

string

None.

City

string

None.

County

County

string

None.

Country

Country

string

None.

JobContact

The JobTitle and Contact-For information of this contact

JobContact

Required

WorksInThisOrganization

Indicates if the Employee/Individual is currently working with the Current Organization (i.e. the Organization that is using this API).

boolean

None.

AddOrganizationAsContact

Gets or sets a value indicating whether [add organization as contact].

boolean

None.

IsOrganizationContact

Gets or Sets IsOrganizationContact

boolean

None.

Id

integer

None.

RelatedToId

integer

None.

MergedWith_Or_Secondary_Id

integer

None.

MergeType

string

None.

SortOrder

integer

None.

Request Format

Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.

{
  "OrganizationName": "String Parameter 1",
  "WebsiteUrl": "String Parameter 2",
  "NoOfEmployees": 1,
  "Email": "String Parameter 3",
  "Fax": "String Parameter 4",
  "Phone": "String Parameter 5",
  "State": "String Parameter 6",
  "Zip": "String Parameter 7",
  "AddressLine1": "String Parameter 8",
  "AddressLine2": "String Parameter 9",
  "AddressLine3": "String Parameter 10",
  "AddressLine4": "String Parameter 11",
  "City": "String Parameter 12",
  "County": "String Parameter 13",
  "Country": "String Parameter 14",
  "JobContact": {
    "JobTitle": "String Parameter 1",
    "ContactFor": "String Parameter 2"
  },
  "WorksInThisOrganization": true,
  "AddOrganizationAsContact": true,
  "IsOrganizationContact": true,
  "Id": 19,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 20",
  "SortOrder": 1
}

Creating the work info

In order to create a new work information, pass the organization information, job title and other relevant parameters, below is an example:

{
  "JobContact": {
    "JobTitle": "Software developer",
    "ContactFor": "Iqr"
  },
  "WorksInThisOrganization": true,
  "AddOrganizationAsContact": false,
  "OrganizationName": "Iqr analytics pvt ltd",
  "IsOrganizationContact": true,
  "RelatedToId": 9831292
}

Response Information

Resource Description

Wrapped result with primary key of the work information added.

ITypedResponseOfInt32
NameDescriptionTypeAdditional information
Result

integer

None.

Category

string

None.

Response Formats

Sample not available.