Add a Company Contact

Request URL

POST {base_url}/uc-ccontact/api/v1/company-contacts

Request parameters

Headers

Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer {access_token}.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters

Note:

• At least one of firstName and lastName must be provided.
• At least one of the following phone fields must be provided:
  • mobilePhone
  • businessPhone
  • homePhone
  • businessFax
  • homeFax
  • mobile2Phone
  • business2Phone
  • home2Phone
  • otherPhone

Parameter	Required	Type	Description
firstName	No	String	The contact's first name.
lastName	No	String	The contact's last name.
company	No	String	The name of the company to which the contact belongs.
email	No	String	The contact's email address.
organization	No	String	The organization or department to which the contact belongs.
jobTitle	No	String	The contact's job title.
position	No	String	The contact's position.
industry	No	String	The industry associated with the contact's organization.
supervisor	No	String	The contact's supervisor.
remark	No	String	Additional notes about the contact.
street	No	String	The street address of the contact.
city	No	String	The city where the contact's address is located.
state	No	String	The state or province where the contact's address is located.
country	No	String	The country where the contact's address is located.
zipCode	No	String	The postal code for the contact's address.
mobilePhone	No	String	The contact's primary mobile phone number.
businessPhone	No	String	The contact's primary business phone number.
homePhone	No	String	The contact's primary home phone number.
businessFax	No	String	The contact's primary business fax number.
homeFax	No	String	The contact's primary home fax number.
mobile2Phone	No	String	The contact's secondary mobile phone number.
business2Phone	No	String	The contact's secondary business phone number.
home2Phone	No	String	The contact's secondary home phone number.
otherPhone	No	String	The contact's additional phone number.

Response parameters

Company_Contact

Parameter	Type	Description
id	String	The unique identifier of the contact.
firstName	String	The contact's first name.
lastName	String	The contact's last name.
company	String	The name of the company to which the contact belongs.
email	String	The contact's email address.
organization	String	The organization or department to which the contact belongs.
jobTitle	String	The contact's job title.
position	String	The contact's position.
industry	String	The industry associated with the contact's organization.
supervisor	String	The contact's supervisor.
remark	String	Additional notes about the contact.
street	String	The street address of the contact.
city	String	The city where the contact's address is located.
state	String	The state or province where the contact's address is located.
country	String	The country where the contact's address is located.
zipCode	String	The postal code for the contact's address.
mobilePhone	String	The contact's primary mobile phone number.
businessPhone	String	The contact's primary business phone number.
homePhone	String	The contact's primary home phone number.
businessFax	String	The contact's primary business fax number.
homeFax	String	The contact's primary home fax number.
mobile2Phone	String	The contact's secondary mobile phone number.
business2Phone	String	The contact's secondary business phone number.
home2Phone	String	The contact's secondary home phone number.
otherPhone	String	The contact's additional phone number.
contactName	String	The display name of the contact.
isFavorited	Boolean	Whether the current user has added the contact to favorites.

Example

Request example

POST /uc-ccontact/api/v1/company-contacts HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTU1NjIyNywiaWF0IjoxNzkxNTM0NjI3LCJqdGkiOiI1OGIyYTM3YS1kM2Q2LTRhYTUtODEwOS1kZTg5ZGE3YTQ5NWMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.z9-FUkQL_rpNNUHl9ddimwioABpVsvQIF403CoYsR8OATIkbpWbxQXDpRD2ydJpkj_6FCqWxee7XjAswlUcn3YMWLo1HeuXFF3TnyS5diTmrAmd4_AL1S3S38pmY4sbgjVFLbZphx85V-HZ35ngZoHkNiyEoondYhF4eyE3SuXgnDRd3PQB-pD5QNzqortzvMAVXlzcTQvTG2OFKvQDVySyFigu0kK35EiL-A1PaBzQCrR768WG-Myk3R6T_Ae1p5IsB3zM0pBs0b_VI6qloo596Hq-yB3GFeCMMGpujTjIa7pk51mzgoOGwcYih8Q5klojv_t0SyoNbxJxXDMVNVw
Content-Type: application/json
x-tenant-code: jint
{
  "firstName": "zz",
  "lastName": "CompanyTest",
  "company": "ZZ Corp",
  "email": "zz@example.com",
  "mobilePhone": "+8613800138000"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "17695ed5199ad1e868d7519e3c497fb4",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "366859309270061056",
    "firstName": "zz",
    "lastName": "CompanyTest",
    "company": "ZZ Corp",
    "email": "zz@example.com",
    "organization": "",
    "jobTitle": "",
    "position": "",
    "industry": "",
    "supervisor": "",
    "remark": "",
    "street": "",
    "city": "",
    "state": "",
    "country": "",
    "zipCode": "",
    "mobilePhone": "+8613800138000",
    "businessPhone": "",
    "homePhone": "",
    "businessFax": "",
    "homeFax": "",
    "mobile2Phone": "",
    "business2Phone": "",
    "home2Phone": "",
    "otherPhone": "",
    "contactName": "zz CompanyTest",
    "isFavorited": false
  }
}