Create a New Contact

Method: POST

Url: /Contacts
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String: None

Request Body:

Parameter Name Data Type Remarks
Parameter Name:

FirstName (Required)

Data Type:

String

Remarks:

The first name of the contact

Parameter Name:

LastName

Data Type:

String

Remarks:

The last name of the contact

Parameter Name:

EmailAddress (Required)

Data Type:

String

Remarks:

The email address of the contact as registered with us

Parameter Name:

Address1 (Required)

Data Type:

String

Remarks:

The first line of contact’s address

Parameter Name:

Address2

Data Type:

String

Remarks:

The second line of contact’s address

Parameter Name:

City (Required)

Data Type:

String

Remarks:
Parameter Name:

State

Data Type:

String

Remarks:

For US states, use the abbreviation, for Non-US states, use the full state name.

Parameter Name:

Zip

Data Type:

String

Remarks:
Parameter Name:

Country

Data Type:

String

Remarks:
Parameter Name:

IsNonUSAddress

Data Type:

Boolean

Remarks:

Whether the address is from outside the USA

Parameter Name:

WorkPhone

Data Type:

String

Remarks:
Parameter Name:

WorkExt

Data Type:

String

Remarks:
Parameter Name:

MobilePhone

Data Type:

String

Remarks:
Parameter Name:

PrimaryContact

Data Type:

Boolean

Remarks:

Whether the contact is the primary contact as registered with us

Parameter Name:

POC

Data Type:

Boolean

Remarks:

Whether the contact is the Point-of-Contact as registered with us

Parameter Name:

Title

Data Type:

String

Remarks:
Parameter Name:

IsSubClient

Data Type:

Boolean

Remarks:

Whether the contact is a client of your organization

Parameter Name:

SubClientOrganizationName

Data Type:

String

Remarks:

The organization name of the contact, applicable only if the contact is a client of your organization (i.e. IsSubClient)

Column Name:

CustomFields

Data Type:

List<CustomField>

Remarks:

List of custom fields (key-value pair) for this record

Request Example:
POST "https://api.dataprise.com/api/v1/Contacts/"

Header: "DPApiAuthenticationToken=abcxyz0123456789"

Body:
	{
		"FirstName": "Test",
		"LastName": "Cntct",
		"EmailAddress": "test@tests.com",
		"City": "New York",
		"State": "NY",
		"Zip": "11111",
		"WorkPhone": "111-111-1111",
		"WorkExt": "123",
		"MobilePhone": "222-222-2222",
		"Title": "",
		"IsSubClient": false,
		"SubClientOrganizationName": "",
		"CustomFields": ["EmployeeID": "1234"]
	}
		  

Response:

The API will return the response as under:

Property Data Type Remarks
Parameter Name:

Status

Data Type:

String

Description:

Status of the request. Either "Success" or "Failure"

Parameter Name:

Message

Data Type:

String

Description:

Error messages if the request failed (i.e. Status = "Failure")

Property:

Id

Data Type:

Integer

Description:

The ID of the created record if the request succeeded (i.e. Status = "Success")

Sample Response:
		{
			"Status": "Success",
			"Message": "",
			"Id": 25
		}