La API de instalaciones locales dejará de estar disponible. Consulta nuestro documento Fin de la API de instalaciones locales para conocer los detalles y descubrir cómo migrar a nuestra nueva generación de API de la nube.
Configuración del perfil de empresa
/v1/settings/business/profile
Usa el punto de conexión /v1/settings/business/profile para configurar las siguientes opciones del perfil de empresa: dirección de la empresa, descripción de la empresa, correo electrónico del contacto de la empresa, industria y sitio web de la empresa.
Antes de empezar
- Debes usar la cuenta
adminpara acceder a la configuración del perfil de empresa.
Consulta
Realiza una llamada GET a la API para recuperar la configuración del perfil de empresa.
Ejemplo:
GET /v1/settings/business/profile
Una respuesta satisfactoria incluye el objeto profile que contiene los datos del perfil de empresa. Para obtener una descripción más detallada de los datos, consulta la lista de parámetros anterior.
{
"settings": {
"business": {
"profile": {
"address": "new-business-address",
"description": "business-description",
"email": "new-business-email",
"vertical": "business-industry",
"websites": [ "website-1", "website-2" ]
}
}
}
Si se produce algún error, consulta Mensajes de error y de estado.
Actualizar la configuración del perfil de empresa
Realiza una llamada a la API POST para actualizar la configuración del perfil de empresa.
Ejemplo:
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
| Nombre | Descripción |
|---|---|
Tipo: cadena | Dirección de la empresa. Máximo de 256 caracteres. |
Tipo: cadena | Descripción de la empresa. Máximo de 512 caracteres. |
Tipo: cadena | Dirección de correo electrónico (en formato de correo electrónico válido) para comunicarse con la empresa. Máximo de 128 caracteres. |
Tipo: cadena | Industria de la empresa. Debe ser uno de los siguientes valores aceptados:
El sector de la empresa no se puede dejar vacío una vez creado. |
Tipo: matriz de cadenas | URL (que incluyen |
Actualizaciones parciales
Si solo necesitas actualizar un par de campos con información nueva, puedes hacer una solicitud para cambiar solo los campos necesarios:
POST /v1/settings/business/profile
{
"address": "new-business-address",
"email": "new-business-email"
}
Si la solicitud se realiza correctamente, se devuelven el código de estado HTTP 200 OK y null o {}. Si se produce algún error, consulta Mensajes de error y de estado.