Estamos retirando la API local. Consulta nuestro documento Retirada de la API local para obtener más información y aprender a migrar a nuestra API de nube de nueva generación.

Configuración del perfil de empresa

/v1/settings/business/profile

Usa el extremo /v1/settings/business/profile para definir las siguientes opciones de configuración del perfil de empresa: dirección de la empresa, descripción de la empresa, correo electrónico del contacto de la empresa, sector de la empresa y sitio web de la empresa.

Antes de empezar

  • Debes usar la cuenta admin para acceder a la configuración del perfil de empresa.

Recuperación

Realiza una llamada a la API GET para recuperar las opciones de configuración del perfil de empresa.

Ejemplo

GET /v1/settings/business/profile

Una respuesta correcta incluye el objeto profile con los datos del perfil de empresa. Para obtener una descripción más detallada de los datos, consulta la lista Parámetros a continuación.

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

Si experimentas algún error, consulta Mensajes de error y de estado.

Actualización de la configuración del perfil de empresa

Realiza una llamada a la API POST para actualizar las opciones de 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

NombreDescripción

address

Tipo: cadena

Dirección de la empresa. Máximo de 256 caracteres.

description

Tipo: cadena

Descripción de la empresa. Máximo de 512 caracteres.

email

Tipo: cadena

Dirección de correo electrónico (en un formato de correo electrónico válido) para contactar con la empresa. Máximo de 128 caracteres.

vertical

Tipo: cadena

Sector de la empresa. Debe ser uno de estos valores aceptados:

  • Automotive
  • Beauty, Spa and Salon
  • Clothing and Apparel
  • Education
  • Entertainment
  • Event Planning and Service
  • Finance and Banking
  • Food and Grocery
  • Public Service
  • Hotel and Lodging
  • Medical and Health
  • Non-profit
  • Professional Services
  • Shopping and Retail
  • Travel and Transportation
  • Restaurant
  • Other

El sector de la empresa no se puede restablecer a un valor vacío después de que se haya creado.

websites

Tipo: matriz de cadenas

Direcciones URL (con http:// o https://) asociadas a la empresa (por ejemplo, sitio web, página de Facebook, Instagram). Máximo de 2 sitios web con un máximo de 256 caracteres cada uno.

Actualizaciones parciales

Si solo necesitas actualizar un par de campos con nueva información, puedes hacer una solicitud solo con los cambios de los campos necesarios:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

Una solicitud correcta devuelve el código de estado HTTP 200 OK y null o {}. Si experimentas algún error, consulta Mensajes de error y de estado.