Businesses
Business API
Documentación de la API de business
Servidor base: https://services.leadconnectorhq.com
Endpoints
- PUT /businesses/{businessId} — Actualizar empresa
- DELETE /businesses/{businessId} — Eliminar empresa
- GET /businesses/{businessId} — Obtener empresa
- GET /businesses/ — Obtener Businesses by Location
- POST /businesses/ — Crear empresa
PUT /businesses/{businessId}
Actualizar empresa Scopes requeridos: businesses.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- businessId (path, string) (requerido) —
Cuerpo de la peticion (application/json):
- name — string
- phone — string
- email — string
- postalCode — string
- website — string
- address — string
- state — string
- city — string
- country — string
- description — string
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /businesses/{businessId}
Eliminar empresa Scopes requeridos: businesses.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- businessId (path, string) (requerido) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /businesses/{businessId}
Obtener empresa Scopes requeridos: businesses.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- businessId (path, string) (requerido) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /businesses/
Obtener Businesses by Location Scopes requeridos: businesses.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- locationId (query, string) (requerido) —
- limit (query, string) —
- skip (query, string) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
POST /businesses/
Crear empresa Scopes requeridos: businesses.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- name (requerido) — string
- locationId (requerido) — string
- phone — string
- email — string
- website — string
- address — string
- city — string
- postalCode — string
- state — string
- country — string
- description — string
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
