Create a System Contact

Published on Feb 9, 2026

7 minute(s) read

Post

/hcm-rest-api/rest/1/syscontact

Overview

The System Contact API is used to create, view and manage contacts. Contacts can be company contacts, business partners, vendors or customers of the company entity setup in CMiC.

System > Security > Users> User Maintenance

Reference Article

https://docs.cmicglobal.com/portal/Content/E_Reference_Material/DocuSign_Integration/Reference/Using_System_Contacts.htm?Highlight

Commonly Used Body Parameters

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example	Required
Contact Code	syscontact	GsyscContactCode	Unique user defined code to identify a contact record	string	10	DA, ZA, DP, ZALL, VB, A1EL-JJ	Yes
Partner Code	syscontact	GsyscPartnCode	Code representing the partner company/ organization the contact belongs to.	string	8	ZZ, TRHI1, A1ELECT, MAESTRO, VBC	Yes
Partner Type Code	syscontact	GsyscPartnTypeCode	Contact type: Business partner, organization, or company, determined by the GsyscPartnCode of the organization with which this contact is associated.	string	1	Company ‘C’ or ‘P’ Partner.	Yes
Last Update Date	syscontact	GsyscLastUpdDate	Date when the contact record was last updated.	datetime		2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ...	Yes
Html Email (Checkbox)	syscontact	GsyscHtmlEmailFlag	Indicates if HTML emails are preferred, Yes - "Y" / No - "N".	string	1	Yes – ‘Y’ / No – ‘N’	Yes
Email 1	syscontact	GsyscEmail1	Primary email address	string	100	da@cmic.ca	No
Is Active (Checkbox)	syscontact	GsyscActiveFlag	A flag indicating whether the contact is active (“Y”) or not active (“N”).	string	1	Yes – ‘Y’ / No – ‘N’	No
Employee Number	syscontact	GsyscEmpNo	Employee number associated with the contact code	string	16	TRHI-WK-SAL1	No
VUUID	syscontact	GsyscVUuid	Virtual Unique Universal Identifier used to retrieve this single record from CMiC.	string	64	9EDA99A5DD392163E0530100007F16DD	No

Other (Optional) Body Parameters

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example	Required
First Name	syscontact	GsyscFirstName	Contact's first name	string	60	Walter	No
Middle Name	syscontact	GsyscMiddleName	Contact's middle name	string	60	Hartwell	No
Last Name	syscontact	GsyscLastName	Contact's last name	string	60	White	No
Prefix	syscontact	GsyscPrefixName	Prefix for the contact's name (e.g., Mr., Ms., Dr.)	string	16	Mr.	No
Contact Description	syscontact	GsyscContactDesc	Description or notes about the contact code	string	300	Consultant, Owner, Electrical Engineer, Testing	No
Address Company Code	syscontact	GsyscAddCompCode	Code representing the contact’s company address	string	8	ZZ, SUS, CCC, …	No
Address Code	syscontact	GsyscAddCode	User defined Address code, identifying the address. Used for reports and log builder.	string	8	ALL, ZSCH, CCC-OH, ...	No
Address Line 1	syscontact	GsyscAddLine1	First line of the contact's address	string	40	137 Union Street	No
Address Line 2	syscontact	GsyscAddLine2	Second line of the contact's address	string	40	0	No
Address Line 3	syscontact	GsyscAddLine3	Third line of the contact's address	string	40	0	No
Region Code	syscontact	GsyscRegionCode	Code representing the geographical region of the contact	string	3	NY – New York	No
Postal Code	syscontact	GsyscPostalCode	Postal or ZIP code of the contact's address	string	12	89120	No
Country	syscontact	GsyscCountry	Country of the contact's address	string	30	USA	No
Work Phone Number	syscontact	GsyscWorkPhoneNum	Work phone number of the contact	string	100	(416) 555-0123	No
Home Phone Number	syscontact	GsyscHomePhoneNum	Home phone number of the contact	string	100	(416) 555-0123	No
Mobile Number	syscontact	GsyscMobileNum	Mobile phone number of the contact	string	40	(416) 555-0123	No
Pager Number	syscontact	GsyscPagerNum	Pager number (if applicable)	string	40	7736529999	No
Fax Number 1	syscontact	GsyscFaxNum1	Primary fax number	string	100	888-567-0023	No
Fax Number 2	syscontact	GsyscFaxNum2	Secondary fax number	string	100	888-555-0023	No
Email 2	syscontact	GsyscEmail2	Secondary email address	string	100	ravi.venkatachalam@cmic.ca	No
Website URL	syscontact	GsyscWwwSite	Contact's website URL	string	100	<www.cmicglobal.com>	No
CLV Value Code 1	syscontact	GsyscClvValueCode1	Classifier Value 1. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.	string	16	0	No
CLV Value Code 2	syscontact	GsyscClvValueCode2	Classifier Value 2. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.	string	16	0	No
CLV Value Code 3	syscontact	GsyscClvValueCode3	Classifier Value 3. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.	string	16	0	No
CLV Value Code 4	syscontact	GsyscClvValueCode4	Classifier Value 4. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.	string	16	0	No
CLV ValueCode 5	syscontact	GsyscClvValueCode5	Classifier Value 5. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.	string	16	0	No
CLV Value Code 6	syscontact	GsyscClvValueCode6	Classifier Value 6. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.	string	16	0	No
PM Role Code	syscontact	GsyscPmRoleCode	Project Role this contact has been assigned to under project management	string	10	MASTER, PROJCOORD, RVMNGR	No
Other Details	syscontact	GsyscOther	Used for additional details or miscellaneous information about the contact	string	200	0	No
Preferred Contact Method	syscontact	GsyscPrefContactMth	Preferred method of contacting the contact (e.g., Email, Phone)	string	10	MAIL, EMAIL, Phone	No
Is Primary (Checkbox)	syscontact	GsyscPrimaryFlag	Indicates if the contact is a Primary Contact for the organization specified by Yes - "Y" / No - "N".	string	1	Yes – ‘Y’ / No – ‘N’	No
Is Bid Contact	syscontact	GsyscBidFlag	This flag indicates if the contact is a bidding contact Yes - "Y" / No - "N".	string	1	Yes – ‘Y’ / No – ‘N’	No
Last Update User	syscontact	GsyscLastUpdUser	User who last updated the contact record	string	30	DAR, UIG, ALV12, ...	No
Collaboration User (checkbox)	syscontact	GsyscCollabUserFlag	Indicates if the contact is a collaboration user, Yes - "Y" / No - "N".	string	1	Yes – ‘Y’ / No – ‘N’	No
Collaboration Usage Price	syscontact	GsyscCollabUsagePrice	Pricing related to collaboration usage	number	18	0	No
Independent Contractor (Checkbox)	syscontact	GsyscIndepContractorFlag	Indicates if the contact is an independent contractor. Yes - "Y" / No - "N".	string	1	Yes – ‘Y’ / No – ‘N’	No
#N/A	syscontact	GsysAltFaxMethodPrefix	#N/A	string	60	#N/A	No
#N/A	syscontact	GsysAltFaxMethodSuffix	#N/A	string	100	#N/A	No
Alternative Fax Method (Checkbox)	syscontact	GsyscAltFaxMethodFlag	Indicates if an alternative fax method is used for the contact Yes - "Y" / No - "N".	string	1	Yes – ‘Y’ / No – ‘N’	No
Alternative Fax Method Prefix	syscontact	GsyscAltFaxMethodPrefix	Prefix for alternative fax methods for the contact	string	60	0	No
Alternative Fax Method Suffix	syscontact	GsyscAltFaxMethodSuffix	Suffix for alternative fax methods for the contact	string	100	0	No
HRSS Role Code	syscontact	GsyscHrssRoleCode	This is the HR Role assigned to the contact for approving related HR ESS Workflows	string	10	DA	No
Name Suffix	syscontact	GsyscSuffixName	Suffix for the contact's name (e.g., Jr., Sr., III)	string	60	Jr., Sr., III	No
Employee Trade Code	syscontact	GpyempTradeCode	Code representing the employee contacts trade or specialty of the GsyscEmpNo	string	4	11PCH, 1610, CE28	No
Trade Name	syscontact	GpytrdTradeName	Name of the trade or specialty for the above GpyempTradeCode for GsyscEmpNo	string	30	0	No
Trade Rate	syscontact	GpytrdTradeRate	Rate associated with the trade or specialty of the GpyempTradeCode	number	16	0	No
Trade Charge Rate	syscontact	GpytrdTradeChargeRate	Charge rate for the trade or specialty of the GpyempTradeCode	number	16	0	No
Trade Billing Rate	syscontact	GpytrdTradeBillingRate	Billing rate for the trade or specialty of the GpyempTradeCode	number	16	0	No
Employee Company Code	syscontact	GpyempCompCode	Code representing the employee's company for GsyscEmpNo	string	8	ZZC, TRHI2, PYUS	No
Employee WRL Code	syscontact	GpyempWrlCode	WRL (Workforce Resource Locator) code for the employee for GsyscEmpNo	string	15	ZCHI, 123	No
Employee WRL Name	syscontact	GpyempWrlName	WRL (Workforce Resource Locator) name for the employee for GsyscEmpNo	string	4000	Company ZZ West Chicago	No
Integration User Create Date	syscontact	GsyscIuCreateDate	Date when this contact record was created in CMiC. Should YYYY-MM-DDThh:mm:ssZ	datetime		2010-06-25T10:51:17-04:00, 2016-01-05T10:44:33-05:00, ...	No
Integration User Update Date	syscontact	GsyscIuUpdateDate	Date when the this contact record was updated in CMiC.	datetime		2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ...	No

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters

object

Example{ "GsyscEmpNo": null, "GsyscEmail1": "jane.doe@cmicglobal.com", "GsyscPartnCode": "013035", "GsyscPartnTypeCode": "P", "GsyscContactCode": "KC", "GsyscLastUpdDate": "2022-09-19T17:35:13Z", "GsyscHtmlEmailFlag": "N", "GsyscActiveFlag": "Y", "GsyscVUuid": "" }

Responses

201

Created

Headers