POST v1/contacts
Creates a new contact for the authenticated user
Request Information
URI Parameters
None.
Body Parameters
Information about a new contact
NewContactModelName | Description | Type | Additional Information |
---|---|---|---|
AccountID |
The Account's unique identifier (Kapta) |
string |
Required. |
FirstName |
Contact First Name |
string |
Required. |
LastName |
Contact Last Name |
string |
None. |
Contact Email address |
string |
Required. |
|
Notes |
A note or description about this contact |
string |
None. |
JobTitle |
Contact's Job Title Number |
string |
None. |
Phone |
Contact's Phone Number |
string |
None. |
Mobile |
Contact's Mobile Number |
string |
None. |
LinkedInURL |
Contact's Linked in URL (should be their public profile url, not the link in your browser) |
string |
None. |
TwitterURL |
Contact's Twitter URL |
string |
None. |
CRMID |
Contact's CRM or external ID |
string |
None. |
CustomFields |
Custom Field List (if they have been defined) |
Collection of UDFFieldModel |
None. |
Request Formats
application/json, text/json, text/html
Sample:
{ "AccountID": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Email": "sample string 4", "Notes": "sample string 5", "JobTitle": "sample string 6", "Phone": "sample string 7", "Mobile": "sample string 8", "LinkedInURL": "sample string 9", "TwitterURL": "sample string 10", "CRMID": "sample string 11", "CustomFields": [ { "FieldName": "sample string 1", "Type": "sample string 2", "StringValue": "sample string 3", "DoubleValue": 4.1, "DatetimeValue": "2025-05-24T11:12:08.6472537+00:00" }, { "FieldName": "sample string 1", "Type": "sample string 2", "StringValue": "sample string 3", "DoubleValue": 4.1, "DatetimeValue": "2025-05-24T11:12:08.6472537+00:00" } ] }
application/xml, text/xml
Sample:
<NewContactModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1"> <AccountID>sample string 1</AccountID> <CRMID>sample string 11</CRMID> <CustomFields> <UDFFieldModel> <DatetimeValue>2025-05-24T11:12:08.6472537+00:00</DatetimeValue> <DoubleValue>4.1</DoubleValue> <FieldName>sample string 1</FieldName> <StringValue>sample string 3</StringValue> <Type>sample string 2</Type> </UDFFieldModel> <UDFFieldModel> <DatetimeValue>2025-05-24T11:12:08.6472537+00:00</DatetimeValue> <DoubleValue>4.1</DoubleValue> <FieldName>sample string 1</FieldName> <StringValue>sample string 3</StringValue> <Type>sample string 2</Type> </UDFFieldModel> </CustomFields> <Email>sample string 4</Email> <FirstName>sample string 2</FirstName> <JobTitle>sample string 6</JobTitle> <LastName>sample string 3</LastName> <LinkedInURL>sample string 9</LinkedInURL> <Mobile>sample string 8</Mobile> <Notes>sample string 5</Notes> <Phone>sample string 7</Phone> <TwitterURL>sample string 10</TwitterURL> </NewContactModel>
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, text/html
Sample:
{ "ID": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Email": "sample string 4", "Notes": "sample string 5", "JobTitle": "sample string 6", "Phone": "sample string 7", "Mobile": "sample string 8", "LinkedInURL": "sample string 9", "TwitterURL": "sample string 10", "CRMID": "sample string 11", "AccountID": "sample string 12", "CustomFields": [ { "FieldName": "sample string 1", "Type": "sample string 2", "StringValue": "sample string 3", "DoubleValue": 4.1, "DatetimeValue": "2025-05-24T11:12:08.6472537+00:00" }, { "FieldName": "sample string 1", "Type": "sample string 2", "StringValue": "sample string 3", "DoubleValue": 4.1, "DatetimeValue": "2025-05-24T11:12:08.6472537+00:00" } ], "Freshness": "2025-05-24T11:12:08.6472537+00:00", "DateModified": "2025-05-24T11:12:08.6472537+00:00", "DateCreated": "2025-05-24T11:12:08.6472537+00:00", "AppUrl": "sample string 15", "Role": [ "sample string 1", "sample string 2" ], "ImageUrl": "sample string 16", "ReportingPerson": { "ID": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Email": "sample string 4" }, "InternalPerson": { "ID": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Email": "sample string 4" }, "IsFriend": "sample string 17", "DecisionPower": "sample string 18", "ContactType": "sample string 19" }
application/xml, text/xml
Sample:
<ContactModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1"> <AccountID>sample string 12</AccountID> <AppUrl>sample string 15</AppUrl> <CRMID>sample string 11</CRMID> <ContactType>sample string 19</ContactType> <CustomFields> <UDFFieldModel> <DatetimeValue>2025-05-24T11:12:08.6472537+00:00</DatetimeValue> <DoubleValue>4.1</DoubleValue> <FieldName>sample string 1</FieldName> <StringValue>sample string 3</StringValue> <Type>sample string 2</Type> </UDFFieldModel> <UDFFieldModel> <DatetimeValue>2025-05-24T11:12:08.6472537+00:00</DatetimeValue> <DoubleValue>4.1</DoubleValue> <FieldName>sample string 1</FieldName> <StringValue>sample string 3</StringValue> <Type>sample string 2</Type> </UDFFieldModel> </CustomFields> <DateCreated>2025-05-24T11:12:08.6472537+00:00</DateCreated> <DateModified>2025-05-24T11:12:08.6472537+00:00</DateModified> <DecisionPower>sample string 18</DecisionPower> <Email>sample string 4</Email> <FirstName>sample string 2</FirstName> <Freshness>2025-05-24T11:12:08.6472537+00:00</Freshness> <ID>sample string 1</ID> <ImageUrl>sample string 16</ImageUrl> <InternalPerson> <Email>sample string 4</Email> <FirstName>sample string 2</FirstName> <ID>sample string 1</ID> <LastName>sample string 3</LastName> </InternalPerson> <IsFriend>sample string 17</IsFriend> <JobTitle>sample string 6</JobTitle> <LastName>sample string 3</LastName> <LinkedInURL>sample string 9</LinkedInURL> <Mobile>sample string 8</Mobile> <Notes>sample string 5</Notes> <Phone>sample string 7</Phone> <ReportingPerson> <Email>sample string 4</Email> <FirstName>sample string 2</FirstName> <ID>sample string 1</ID> <LastName>sample string 3</LastName> </ReportingPerson> <Role xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Role> <TwitterURL>sample string 10</TwitterURL> </ContactModel>