Schemas-Forms

BadRequestDTO

statusCode
number
Example:
400
message
string
Example:
Bad Request
Example 
{
  "statusCode": 400,
  "message": "Bad Request"
}

UnauthorizedDTO

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
Example 
{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

PageDetailsSchema

url
string
Example:
https://example.com
title
string
Example:
Example Page
Example 
{
  "url": "https://example.com",
  "title": "Example Page"
}

ContactSessionIds

ids
array[string] or null
Example:
["session1","session2"]
Example 
{
  "ids": [
    "session1",
    "session2"
  ]
}

EventDataSchema

fbc
string
Example:
fb.1.123456789.987654321
fbp
string
Example:
fbp.1.987654321.123456789
page
object
url
string
Example:
https://example.com
title
string
Example:
Example Page
type
string
Example:
page-visit
domain
string
Example:
example.com
medium
string
Example:
form
source
string
Example:
Direct traffic
version
string
Example:
v3
adSource
string
Example:
example-ad-source
mediumId
string
Example:
medium-id-123
parentId
string
Example:
parent-id-456
referrer
string
Example:
https://staging.gohighlevel.com
fbEventId
string
Example:
event-id-789
timestamp
number
Example:
1234567890
parentName
string
Example:
Parent Form
fingerprint
string
Example:
example-fingerprint
pageVisitType
string
Example:
form
contactSessionIds
object or null
ids
array[string] or null
Example:
["session1","session2"]
Example 
{
  "fbc": "fb.1.123456789.987654321",
  "fbp": "fbp.1.987654321.123456789",
  "page": {
    "url": "https://example.com",
    "title": "Example Page"
  },
  "type": "page-visit",
  "domain": "example.com",
  "medium": "form",
  "source": "Direct traffic",
  "version": "v3",
  "adSource": "example-ad-source",
  "mediumId": "medium-id-123",
  "parentId": "parent-id-456",
  "referrer": "https://staging.gohighlevel.com",
  "fbEventId": "event-id-789",
  "timestamp": 1234567890,
  "parentName": "Parent Form",
  "fingerprint": "example-fingerprint",
  "pageVisitType": "form",
  "contactSessionIds": {
    "ids": [
      "session1",
      "session2"
    ]
  }
}

othersSchema

__submissions_other_field__
string
Example:
john@deo.com
__custom_field_id__
string
Example:
20
eventData
object
fbc
string
Example:
fb.1.123456789.987654321
fbp
string
Example:
fbp.1.987654321.123456789
page
object
type
string
Example:
page-visit
domain
string
Example:
example.com
medium
string
Example:
form
source
string
Example:
Direct traffic
version
string
Example:
v3
adSource
string
Example:
example-ad-source
mediumId
string
Example:
medium-id-123
parentId
string
Example:
parent-id-456
referrer
string
Example:
https://staging.gohighlevel.com
fbEventId
string
Example:
event-id-789
timestamp
number
Example:
1234567890
parentName
string
Example:
Parent Form
fingerprint
string
Example:
example-fingerprint
pageVisitType
string
Example:
form
contactSessionIds
object or null
fieldsOriSequance
array[string]
Example:
["full_name","first_name","last_name","phone","email"]
Example 
{
  "__submissions_other_field__": "john@deo.com",
  "__custom_field_id__": "20",
  "eventData": {
    "fbc": "fb.1.123456789.987654321",
    "fbp": "fbp.1.987654321.123456789",
    "page": {
      "url": "https://example.com",
      "title": "Example Page"
    },
    "type": "page-visit",
    "domain": "example.com",
    "medium": "form",
    "source": "Direct traffic",
    "version": "v3",
    "adSource": "example-ad-source",
    "mediumId": "medium-id-123",
    "parentId": "parent-id-456",
    "referrer": "https://staging.gohighlevel.com",
    "fbEventId": "event-id-789",
    "timestamp": 1234567890,
    "parentName": "Parent Form",
    "fingerprint": "example-fingerprint",
    "pageVisitType": "form",
    "contactSessionIds": {
      "ids": [
        "session1",
        "session2"
      ]
    }
  },
  "fieldsOriSequance": [
    "full_name",
    "first_name",
    "last_name",
    "phone",
    "email"
  ]
}

FormsSubmissionsSubmissionsSchema

id
string
Example:
38303ec7-629a-49e2-888a-cf8bf0b1f97e
contactId
string
Example:
DWQ45t2IPVxi9LDu1wBl
createdAt
string
Example:
2021-06-23T06:07:04.000Z
formId
string
Example:
YSWdvS4Is98wtIDGnpmI
name
string
Example:
test
email
string
Example:
test@test.com
others
object
__submissions_other_field__
string
Example:
john@deo.com
__custom_field_id__
string
Example:
20
eventData
object
fieldsOriSequance
array[string]
Example:
["full_name","first_name","last_name","phone","email"]
Example 
{
  "id": "38303ec7-629a-49e2-888a-cf8bf0b1f97e",
  "contactId": "DWQ45t2IPVxi9LDu1wBl",
  "createdAt": "2021-06-23T06:07:04.000Z",
  "formId": "YSWdvS4Is98wtIDGnpmI",
  "name": "test",
  "email": "test@test.com",
  "others": {
    "__submissions_other_field__": "john@deo.com",
    "__custom_field_id__": "20",
    "eventData": {
      "fbc": "fb.1.123456789.987654321",
      "fbp": "fbp.1.987654321.123456789",
      "page": {},
      "type": "page-visit",
      "domain": "example.com",
      "medium": "form",
      "source": "Direct traffic",
      "version": "v3",
      "adSource": "example-ad-source",
      "mediumId": "medium-id-123",
      "parentId": "parent-id-456",
      "referrer": "https://staging.gohighlevel.com",
      "fbEventId": "event-id-789",
      "timestamp": 1234567890,
      "parentName": "Parent Form",
      "fingerprint": "example-fingerprint",
      "pageVisitType": "form",
      "contactSessionIds": {
        "ids": []
      }
    },
    "fieldsOriSequance": [
      "full_name",
      "first_name",
      "last_name",
      "phone",
      "email"
    ]
  }
}

metaSchema

locationId
string
required
Example:
ve9EPM428h8vShlRW1KT
title
string
Example:
template title
type
string
required
Allowed values:
htmlfolderimportbuilderblank
updatedBy
string
Example:
zYy3YOUuHxgomU1uYJty
builderVersion
string
Allowed values:
12
Default:
2
name
string
Example:
Template1
parentId
string
Example:
zYy3YOUuHxgomU1uYJty
templateDataUrl
string
Example:
importProvider
string
required
Allowed values:
mailchimpactive_campaignkajabi
importURL
string
Example:
https://tplshare.com/fhYJ3Mi
templateSource
string
Example:
template_library
isPlainText
boolean
Example:
false
Example 
{
  "total": 1,
  "currentPage": 1,
  "nextPage": null,
  "prevPage": null
}

FormsSubmissionsSuccessfulResponseDto

submissions
array[object]
id
string
Example:
38303ec7-629a-49e2-888a-cf8bf0b1f97e
contactId
string
Example:
DWQ45t2IPVxi9LDu1wBl
createdAt
string
Example:
2021-06-23T06:07:04.000Z
formId
string
Example:
YSWdvS4Is98wtIDGnpmI
name
string
Example:
test
email
string
Example:
test@test.com
others
object
__submissions_other_field__
string
Example:
john@deo.com
__custom_field_id__
string
Example:
20
eventData
object
fieldsOriSequance
array[string]
Example:
["full_name","first_name","last_name","phone","email"]
meta
object
total
number
Example:
1
currentPage
number
Example:
1
nextPage
number or null
Example:
null
prevPage
number or null
Example:
null
Example 
{
  "submissions": [
    {
      "id": "38303ec7-629a-49e2-888a-cf8bf0b1f97e",
      "contactId": "DWQ45t2IPVxi9LDu1wBl",
      "createdAt": "2021-06-23T06:07:04.000Z",
      "formId": "YSWdvS4Is98wtIDGnpmI",
      "name": "test",
      "email": "test@test.com",
      "others": {
        "eventData": {},
        "fieldsOriSequance": []
      }
    }
  ],
  "meta": {
    "total": 1,
    "currentPage": 1,
    "nextPage": null,
    "prevPage": null
  }
}

UnprocessableDTO

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
Example 
{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

FormsParams

id
string
Example:
YSWdvS4Is98wtIDGnpmI
name
string
Example:
Form 1
locationId
string
Example:
ve9EPM428h8vShlRW1KT
Example 
{
  "id": "YSWdvS4Is98wtIDGnpmI",
  "name": "Form 1",
  "locationId": "ve9EPM428h8vShlRW1KT"
}

FormsSuccessfulResponseDto

forms
array[object]
id
string
Example:
YSWdvS4Is98wtIDGnpmI
name
string
Example:
Form 1
locationId
string
Example:
ve9EPM428h8vShlRW1KT
total
number

Total number of forms

Example:
20
Example 
{
  "forms": [
    {
      "id": "YSWdvS4Is98wtIDGnpmI",
      "name": "Form 1",
      "locationId": "ve9EPM428h8vShlRW1KT"
    }
  ],
  "total": "20"
}