Create a Contact
POST {{base_url}}/contact
Use this endpoint to create a new contact in the Contacts hub.
Specify the data for the new contact in the request body. Minimum required data include required fields and defaults from the contact metadata. Each contact object includes names, addresses, phone numbers, related firms, and activities as well as details about future opportunities.
The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.
Request
A successful call status of 201 Created returns the JSON representation for the newly created contact.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
Request Body
[{"name"=>"ContactID", "value"=>"String", "datatype"=>"string"}, {"name"=>"Salutation", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"FirstName", "value"=>"String", "datatype"=>"string"}, {"name"=>"MiddleName", "value"=>"String", "datatype"=>"string"}, {"name"=>"LastName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Suffix", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"PreferredName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Title", "value"=>"String", "datatype"=>"string"}, {"name"=>"Source", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"ClientID", "value"=>"String", "datatype"=>"string"}, {"name"=>"ClientName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Vendor", "value"=>"Vendor", "datatype"=>"string"}, {"name"=>"VName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Email", "value"=>"String", "datatype"=>"string"}, {"name"=>"ContactStatus", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"CustomCurrrencyCode", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Address1", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address2", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address3", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address4", "value"=>"String", "datatype"=>"string"}, {"name"=>"City", "value"=>"String", "datatype"=>"string"}, {"name"=>"State", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Zip", "value"=>"String", "datatype"=>"string"}, {"name"=>"Country", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Phone", "value"=>"String", "datatype"=>"string"}, {"name"=>"Fax", "value"=>"String", "datatype"=>"string"}, {"name"=>"CellPhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"HomePhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"Pager", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailingAddress", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmAddress1", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmAddress2", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmAddress3", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmAddress4", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmCity", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmState", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"FirmZip", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmCountry", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"FirmBusinessPhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmBusinessPhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmBusinessFax", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmBusinessFaxFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmPager", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirmDescription", "value"=>"String", "datatype"=>"string"}, {"name"=>"Memo", "value"=>"String", "datatype"=>"string"}, {"name"=>"Billing", "value"=>"String", "datatype"=>"string"}, {"name"=>"PrimaryInd", "value"=>"String", "datatype"=>"string"}, {"name"=>"Addressee", "value"=>"String", "datatype"=>"string"}, {"name"=>"CLAddress", "value"=>"String", "datatype"=>"string"}, {"name"=>"VEAddress", "value"=>"String", "datatype"=>"string"}, {"name"=>"CreateUser", "value"=>"String", "datatype"=>"string"}, {"name"=>"CreateDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"ModUser", "value"=>"String", "datatype"=>"string"}, {"name"=>"ModDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"CellPhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"HomePhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"PagerFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"Company", "value"=>"String", "datatype"=>"string"}, {"name"=>"flName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Owner", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"emOwnerfl", "value"=>"String", "datatype"=>"string"}, {"name"=>"TopTPStartDate", "value"=>"String", "datatype"=>"string"}, {"name"=>"TopTPSubject", "value"=>"String", "datatype"=>"string"}, {"name"=>"TopTPContactID", "value"=>"String", "datatype"=>"string"}, {"name"=>"TopTPCreateEmployee", "value"=>"String", "datatype"=>"string"}, {"name"=>"TopTPCreateUserName", "value"=>"String", "datatype"=>"string"}, {"name"=>"HasPhoto", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PhotoModDate", "value"=>"String", "datatype"=>"string"}, {"name"=>"TLInternalKey", "value"=>"String", "datatype"=>"string"}, {"name"=>"TLSyncModDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"Rating", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Market", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Website", "value"=>"String", "datatype"=>"string"}, {"name"=>"QualifiedStatus", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"StatusReason", "value"=>"String", "datatype"=>"string"}, {"name"=>"StatusDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"ProfessionalSuffix", "value"=>"String", "datatype"=>"string"}, {"name"=>"SFID", "value"=>"String", "datatype"=>"string"}, {"name"=>"AjeraSync", "value"=>"String", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: Created
{"ContactID":"ADMIN1013718587810","Salutation":"Mr.","FirstName":"Test","MiddleName":"M.","LastName":"Testerson","Suffix":"AIA","PreferredName":"Preferred Name","Title":"Director of Marketing","Source":"Newspaper","ClientID":"000VISCONI","ClientName":"Anderson \u0026 Associates, LLC","Vendor":"","VName":"","Email":"email@company.com","ContactStatus":"A","CustomCurrencyCode":"USD","Address1":"111 Main Street","Address2":"Suite 300","Address3":"","Address4":"","City":"Boston","State":"MA","Zip":"12345","Country":"","Phone":"123.456.7890","Fax":"123.4567.890","CellPhone":"123.456.7890","HomePhone":"123.456.7890","Pager":"1234567890","MailingAddress":"N","FirmAddress1":"100 Sterling Heights Avenue","FirmAddress2":"Suite 510","FirmAddress3":"","FirmAddress4":"","FirmCity":"New York","FirmState":"NY","FirmZip":"25410","FirmCountry":"US","FirmBusinessPhone":"123.456.7890","FirmBusinessPhoneFormat":"","FirmBusinessFax":"123.456.7890","FirmBusinessFaxFormat":"","FirmPager":"123.456.7890","FirmDescription":"","Memo":"","Billing":"N","PrimaryInd":"N","Addressee":"","CLAddress":"\u003cDefault\u003e","VEAddress":"","CreateUser":"William Apple","CreateDate":"2018-02-14T15:31:04.000","ModUser":"William Apple","ModDate":"2018-06-20T14:56:42.753","CellPhoneFormat":"","HomePhoneFormat":"","PagerFormat":"","Company":"Anderson \u0026 Associates, LLC","flName":"Test Testerson, AIA ","Owner":"","emOwnerfl":"William Apple, Sr.","TopTPStartDate":"","TopTPSubject":"","TopTPContactID":"","TopTPCreateEmployee":"","TopTPCreateUserName":"","HasPhoto":0,"PhotoModDate":"","TLInternalKey":"","TLSyncModDate":"","ProjectDescription":"","Rating":"","Market":"","Website":"www.deltek.com","QualifiedStatus":"sysQual","StatusReason":"","StatusDate":"2017-03-30T17:50:31.520","ProfessionalSuffix":"","SFID":"","AjeraSync":""}