Skip to main content

Renaming the instance

Method#

/update-name#

PUT https://api.z-api.io/instances/ID_INSTANCE/token/TOKEN_INSTANCE/update-name

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

Method used to rename an instance.


Atributos#

AttributesTypeDescription
valuestringNew name for an instance

Request Body#

Body
{
"value": "novo nome"
}

Response#

200#

Return
{
"value": true
}

405#

In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or PUT as specified at the beginning of this topic.

415#

In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”


Code#