Forms

Forms API

Documentación de la API de forms

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

Endpoints

• GET /forms/submissions — Obtener Forms Submissions
• POST /forms/upload-custom-files — Upload files to custom fields
• GET /forms/ — Obtener formularios

GET /forms/submissions

Obtener Forms Submissions Scopes requeridos: forms.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — - page (query, number) — Page No. By default it will be 1 - limit (query, number) — Limit Per Page records count. will allow maximum up to 100 and default will be 20 - formId (query, string) — Id de Filter submission by form - q (query, string) — Filter by contactId, name, email or phone no. - startAt (query, string) — Get submission by starting of this date. By default it will be same date of last month(YYYY-MM-DD). - endAt (query, string) — Get submission by ending of this date. By default it will be current date(YYYY-MM-DD).

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

POST /forms/upload-custom-files

Upload files to custom fields Post the necessary fields for the API to upload files. The files need to be a buffer with the key "< custom_field_id >_< file_id >".
Here custom field id is the Id of your custom field and file id is a randomly generated id (or uuid)
There is support for multiple file uploads as well. Have multiple fields in the format mentioned.
File size is limited to 50 MB.

The allowed file types are:

• PDF
• DOCX
• DOC
• JPG
• JPEG
• PNG
• GIF
• CSV
• XLSX
• XLS
• MP4
• MPEG
• ZIP
• RAR
• TXT
• SVG

Scopes requeridos: forms.write, forms.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - contactId (query, string) (requerido) — Contact Id to upload the file to. - locationId (query, string) (requerido) — Location Id of the contact.

Cuerpo de la peticion (multipart/form-data): - (ver esquema en la fuente original)

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

GET /forms/

Obtener formularios Scopes requeridos: forms.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — - skip (query, number) — - limit (query, number) — Limit Per Page records count. will allow maximum up to 50 and default will be 10 - type (query, string) —

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