Skip to main content

Change Company Address

Method#

/business/company-address#

POST https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/business/company-address

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

Through this method, it is possible to change the company's commercial address.

Important

This method is only available for Business WhatsApp accounts.


Attributes#

Optional#

AttributesTypeDescription
valuestringCompany's address

Request Body#

{
"value": "Company address"
}
Tip

To remove the address, simply send the "value" attribute as empty.


Response#

201#

AttributesTypeDescription
successbooleantrue if successful, false in case of failure

Example

{
"success": true
}

405#

In this case, ensure that you are sending the method specification correctly, i.e., check if you sent the POST or PUT as specified at the beginning of this topic.

415#

If you receive a 415 error, make sure to add the "Content-Type" of the object you are sending in the request headers, in most cases, it should be "application/json".


Code#