Links

Trigger Links API

Documentación de la API de links

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

Endpoints

• GET /links/id/{linkId} — Obtener Link by Id
• PUT /links/{linkId} — Actualizar enlace
• DELETE /links/{linkId} — Eliminar enlace
• GET /links/search — Buscar Trigger Links
• GET /links/ — Obtener enlaces
• POST /links/ — Crear enlace

GET /links/id/{linkId}

Obtener Link by Id Get a single link by its Id

Scopes requeridos: links.readonly

Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de sede - linkId (path, string) (requerido) — Id de enlace

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

PUT /links/{linkId}

Actualizar enlace Scopes requeridos: links.write

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

Cuerpo de la peticion (application/json): - name (requerido) — string — Display name of the trigger link - redirectTo (requerido) — string — URL or variable to redirect to when the trigger link is clicked

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

DELETE /links/{linkId}

Eliminar enlace Scopes requeridos: links.write

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

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

GET /links/search

Buscar Trigger Links Get list of links by searching

Scopes requeridos: links.readonly

Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de sede - query (query, string) — Search query as a string - skip (query, number) — Numbers of query results to skip - limit (query, number) — Limit on number of search results

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

GET /links/

Obtener enlaces Scopes requeridos: links.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Location Id of the business profile

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

POST /links/

Crear enlace Scopes requeridos: links.write

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

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id of the business profile - name (requerido) — string — Display name of the trigger link - redirectTo (requerido) — string — URL or variable to redirect to when the trigger link is clicked

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