A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.
Configurações do perfil comercial
/v1/settings/business/profile
Use o ponto de extremidade /v1/settings/business/profile para definir as seguintes configurações do perfil comercial: endereço, descrição, email de contato, setor e site da empresa.
Antes de começar
- É necessário usar a conta de
adminpara acessar as configurações do perfil comercial.
Recuperação
Faça uma chamada de API GET para recuperar as configurações.
Exemplo
GET /v1/settings/business/profile
Se for bem-sucedida, a resposta incluirá o objeto profile com os dados do perfil comercial. Consulte a lista de parâmetros abaixo para ver as descrições dos dados.
{
"settings": {
"business": {
"profile": {
"address": "new-business-address",
"description": "business-description",
"email": "new-business-email",
"vertical": "business-industry",
"websites": [ "website-1", "website-2" ]
}
}
}
Se houver algum erro, consulte Mensagens de erro e status.
Atualizar as configurações do perfil comercial
Faça uma chamada de API POST para atualizar as configurações.
Exemplo
POST /v1/settings/business/profile
{
"address": "your-business-address",
"description": "your-business-description",
"email": "your-business-email",
"vertical": "your-business-industry",
"websites": [ "your-website-1", "your-website-2" ]
}
Parâmetros
| Nome | Descrição |
|---|---|
Tipo: string | O endereço da empresa. Limite de 256 caracteres. |
Tipo: string | A descrição da empresa. Limite de 512 caracteres. |
Tipo: string | O email de contato da empresa (em formato válido). Limite de 128 caracteres. |
Tipo: string | O setor da empresa. Deve ser um dos valores aceitos:
Depois que o setor for escolhido, não será possível definir um valor vazio para o campo. |
Tipo: matriz de strings | As URLs (incluindo |
Atualizações parciais
Caso você não precise atualizar todas as informações, faça uma solicitação para alterar somente os campos necessários:
POST /v1/settings/business/profile
{
"address": "new-business-address",
"email": "new-business-email"
}
Se for bem-sucedida, a solicitação retornará o código de status HTTP 200 OK, bem como null ou {}. Se houver algum erro, consulte Mensagens de erro e status.