Documentación
superleads.mx
Documentación › Referencia de la API › Locations

Locations

Referencia de la API · ☕ 14 min de lectura
Actualizado el 19 Jun 2026

Sub-Account (Formerly location) API

Documentación de la API de Sub-Account (Formerly location)

Servidor base: https://services.leadconnectorhq.com

Endpoints

GET /locations/search

Search Search Sub-Account (Formerly Location)

Scopes requeridos: locations.readonly, locations.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - companyId (query, string) — The company/agency id on which you want to perform the search - skip (query, string) — The value by which the results should be skipped. Default will be 0 - limit (query, string) — The value by which the results should be limited. Default will be 10 - order (query, string) — The order in which the results should be returned - Allowed values asc, desc. Default will be asc - email (query, string) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}

Obtener Sub-Account (Formerly Location) Get details of a Sub-Account (Formerly Location) by passing the sub-account id

Scopes requeridos: locations.readonly, locations.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /locations/{locationId}

Put Sub-Account (Formerly Location) Update a Sub-Account (Formerly Location) based on the data provided

Scopes requeridos: locations.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - name — string — The name for the sub-account/location - phone — string — The phone number of the business for which sub-account is created - companyId (requerido) — string — Company/Agency Id - address — string — The address of the business for which sub-account is created - city — string — The city where the business is located for which sub-account is created - state — string — The state in which the business operates for which sub-account is created - country — string — The country in which the business is present for which sub-account is created - postalCode — string — The postal code of the business for which sub-account is created - website — string — The website of the business for which sub-account is created - timezone — string — The timezone of the business for which sub-account is created - prospectInfo — - settings — — The default settings for location - social — — The social media links for location - twilio — — (DEPRECATED) The twilio credentials for location - mailgun — — The mailgun credentials for location - snapshot — — The snapshot to be updated in the location.

Respuestas: - 200 — Successful update response - 400 — Peticion invalida - 401 — No autorizado

DELETE /locations/{locationId}

Eliminar Sub-Account (Formerly Location) Delete a Sub-Account (Formerly Location) from the Agency

Scopes requeridos: locations.internal-access-only

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - deleteTwilioAccount (query, boolean) (requerido) — Boolean value to indicate whether to delete Twilio Account or not

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /locations/{locationId}/permissions

Obtener permisos Get Sub-Account (Formerly Location) permissions

Scopes requeridos: locations/write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /locations/{locationId}/permissions

Actualizar permisos Update Sub-Account (Formerly Location) permissions

Scopes requeridos: locations/write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - permissions (requerido) — array — Permission plan values to apply for the sub-account

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/tags

Obtener etiquetas Get Sub-Account (Formerly Location) Tags

Scopes requeridos: locations/tags.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /locations/{locationId}/tags

Crear etiqueta Create tag

Scopes requeridos: locations/tags.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - name (requerido) — string — Tag name

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/tags/{tagId}

Obtener tag by id Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - tagId (path, string) (requerido) — Id de etiqueta

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /locations/{locationId}/tags/{tagId}

Actualizar etiqueta Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - tagId (path, string) (requerido) — Id de etiqueta

Cuerpo de la peticion (application/json): - name (requerido) — string — Tag name

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /locations/{locationId}/tags/{tagId}

Eliminar etiqueta Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - tagId (path, string) (requerido) — Id de etiqueta

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /locations/{locationId}/tasks/search

Task Search Filter Task Search

Scopes requeridos: locations/tasks.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - contactId — array — Contact Ids - completed — boolean — Task Completed Or Pending - assignedTo — array — Assigned User Ids - query — string — Search Value - limit — number — Limit To Api - skip — number — Number Of Tasks To Skip - businessId — string — Bussiness Id

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/recurring-tasks/{id}

Obtener Recurring Task By Id Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de Recurring Task - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

PUT /locations/{locationId}/recurring-tasks/{id}

Actualizar Recurring Task Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de Recurring Task - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - title — string — Name of the task - description — string — Description of the task - contactIds — array — Contact Id - owners — array — Assigned To - rruleOptions — — Recurring rules - ignoreTaskCreation — boolean — Create initial task or not

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

DELETE /locations/{locationId}/recurring-tasks/{id}

Eliminar Recurring Task Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de Recurring Task - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /locations/{locationId}/recurring-tasks

Crear Recurring Task Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) —

Cuerpo de la peticion (application/json): - title (requerido) — string — Name of the task - description — string — Description of the task - contactIds — array — Contact Id - owners — array — Assigned To - rruleOptions (requerido) — — Recurring rules - ignoreTaskCreation — boolean — Create initial task or not

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /locations/{locationId}/customFields

Obtener campos personalizados Scopes requeridos: locations/customFields.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - model (query, string) — Model of the custom field you want to retrieve

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /locations/{locationId}/customFields

Crear campo personalizado Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - name (requerido) — string - dataType (requerido) — string - placeholder — string - acceptedFormat — array - isMultipleFile — boolean - maxNumberOfFiles — number - textBoxListOptions — array - position — number - model — string — Model of the custom field you want to create

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/customFields/{id}

Obtener campo personalizado Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Custom Field Id or Field Key (e.g. "contact.first_name" or "opportunity.pipeline_id")

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /locations/{locationId}/customFields/{id}

Actualizar campo personalizado Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Id de campo personalizado

Cuerpo de la peticion (application/json): - name (requerido) — string - placeholder — string - acceptedFormat — array - isMultipleFile — boolean - maxNumberOfFiles — number - textBoxListOptions — array - position — number - model — string — Model of the custom field you want to update

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /locations/{locationId}/customFields/{id}

Eliminar campo personalizado Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Id de campo personalizado

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /locations/{locationId}/customFields/upload

Uploads File to customFields Scopes requeridos: locations/customFields.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) —

Cuerpo de la peticion (multipart/form-data): - id — string — Id(Contact Id/Opportunity Id/Custom Field Id) - maxFiles — string — Max number of files

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/customValues

Obtener valores personalizados Scopes requeridos: locations/customValues.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /locations/{locationId}/customValues

Crear valor personalizado Scopes requeridos: locations/customValues.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - name (requerido) — string - value (requerido) — string

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/customValues/{id}

Obtener valor personalizado Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Id de valor personalizado

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /locations/{locationId}/customValues/{id}

Actualizar valor personalizado Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Id de valor personalizado

Cuerpo de la peticion (application/json): - name (requerido) — string - value (requerido) — string

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /locations/{locationId}/customValues/{id}

Eliminar valor personalizado Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Id de valor personalizado

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/timezones

Fetch Timezones Fetch the available timezones

Scopes requeridos: locations.readonly, locations.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /locations/{locationId}/templates

Obtener todos los or email/sms templates Scopes requeridos: locations/templates.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - deleted (query, boolean) — - skip (query, string) — - limit (query, string) — - type (query, string) — - originId (query, string) (requerido) — Id de Origin - locationId (path, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /locations/{locationId}/templates/{id}

Eliminar an email/sms template Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - id (path, string) (requerido) — Id de plantilla

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /locations/

Crear Sub-Account (Formerly Location)

Create a new Sub-Account (Formerly Location) based on the data provided

:::info This feature is only available on Agency Pro ($497) plan. :::

Scopes requeridos: locations.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - name (requerido) — string — The name for the sub-account/location - phone — string — The phone number of the business for which sub-account is created with the appropriate country-code - companyId (requerido) — string — Company/Agency Id - address — string — The address of the business for which sub-account is created - city — string — The city where the business is located for which sub-account is created - state — string — The state in which the business operates for which sub-account is created - country — string — The 2 letter country-code in which the business is present for which sub-account is created - postalCode — string — The postal code of the business for which sub-account is created - website — string — The website of the business for which sub-account is created - timezone — string — The timezone of the business for which sub-account is created - prospectInfo — - settings — — The default settings for location - social — — The social media links for location - twilio — — (DEPRECATED) The twilio credentials for location - mailgun — — The mailgun credentials for location - snapshotId — string — The snapshot Id to be loaded into the location.

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /locations/{locationId}/conversationChannels/{type}

Obtener Conversation Channel Get the conversation channel providers configured for a location by type (SMS or Email)

Scopes requeridos: locations.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (path, string) (requerido) — Id de sede - type (path, string) (requerido) — Channel type to retrieve providers for

Respuestas: - 200 — Retrieved all the conversation channels - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar