Add a Company Contact
Add a company contact.
Request URL
{base_url}/{api_path}/companycontacts/add?token={token}
Request parameters
Note:
lastname
, firstname
, and at least a phone number
are required.Parameter | Required | Type | Description |
---|---|---|---|
lastname | Yes | String | The contact's last name. |
firstname | Yes | String | The contact's first name. |
company | No | String | The name of the company where the contact works. |
No | String | The contact's email address. | |
businessnum | No | String | The contact's business number. |
businessnum2 | No | String | The contact's another business number. |
mobile | No | String | The contact's mobile number. |
mobile2 | No | String | The contact's another mobile number. |
homenum | No | String | The contact's home number. |
homenum2 | No | String | The contact's another home number. |
businessfax | No | String | The contact's business fax number. |
homefax | No | String | The contact's home fax number. |
othernum | No | String | The contact's other number. |
zipcode | No | String | The zip code of the city where the contact lives. |
street | No | String | The street where the contact lives. |
city | No | String | The city where the contact lives. |
state | No | String | The state where the contact lives. |
country | No | String | The country where the contact lives. |
Response parameters
Parameter | Type | Description |
---|---|---|
status | String | Request result.
|
id | Integer | A unique ID of the company contact. |
Examples
Request exampleAdd a company contact Maggie Chou whose business number is
15880123456.
Response
examplePOST /api/v2.0.0/companycontacts/add?token=02c893a131633e96771eb9af3b14f0e2
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
"firstname": "Maggie",
"lastname": "Chou",
"businessnum": "15880123456"
}
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
"status": "Success",
"id": "12"
}