Edit a Company Contact

Edit a company contact's information, such as email address, mobile number, etc.

Request URL

{base_url}/{api_path}/companycontacts/update?token={token}

Request parameters

Parameter Required Type Description
id Yes Integer A unique ID of a company contact.
lastname No String The contact's last name.
firstname No String The contact's first name.
company No String The name of the company where the contact works.
email 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.
  • Success
  • Failed

Examples

Request example

Set email address to "maggie@yeastar.com" for the company contact with id 13.
POST /api/v2.0.0/companycontacts/update?token=42e4fc1a0d093ec973a5bcfb28424fcb
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com

{
	"id": "13",
	"email": "maggie@yeastar.com"
}
Response example
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"
}