forms

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-forms"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3a095c68-d07c-4776-8a75-070cf1437150/social-card.svg?v=3e7ae33eec8b" alt="forms" width="600" height="315"></a>
GEThttps://hermeticor.com/p/f/{ref}/companies

Company suggestions for a hosted form

Parameters

qstringqueryrequired
limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/f/{ref}/companies?q=<q>"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    "string"
  ],
  "nextCursor": "string"
}
Schema
itemsstring[]required
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

GEThttps://hermeticor.com/ingest/v1/site-messages

Site messages for this visitor: published ones, plus those a journey queued for them

Parameters

aidstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/ingest/v1/site-messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "messages": [
    {
      "id": "string",
      "html": "string",
      "style": "banner",
      "targeting": {},
      "ctaLabel": "string",
      "ctaUrl": "string",
      "queued": true
    }
  ]
}
Schema
messagesobject[]required
Show child parameters
idstringrequired
htmlstringrequired
stylestringrequired
banner | modal | slide_in
targetingobjectrequired
ctaLabelstringrequired
ctaUrlstringrequired
queuedbooleanrequired
4XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

POSThttps://hermeticor.com/ingest/v1/site-messages/{id}/shown

The visitor saw a site message (a queued one stops showing)

Parameters

idstringpathrequired

Request body

application/json
aidstring
{
  "aid": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/ingest/v1/site-messages/{id}/shown" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"aid":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

GEThttps://hermeticor.com/v1/site-messages

Parameters

limitintegerquery
= 50
cursorstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/site-messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "name": "string",
      "html": "string",
      "style": "banner",
      "audience": "everyone",
      "targeting": {},
      "ctaLabel": "string",
      "ctaUrl": "string",
      "id": "string",
      "status": "draft",
      "createdAt": "2024-01-01T00:00:00Z",
      "shown": 0,
      "queued": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem213[]required
Show child parameters
namestringrequired
htmlstringrequired
stylestringrequired
banner | modal | slide_in = banner
audiencestringrequired
everyone | journey = everyone
targetingobjectrequired
= {}
Show child parameters
urlIncludestring[]
urlExcludestring[]
delaySecondsnumber
scrollPercentnumber
exitIntentboolean
mobileBackExitboolean
inactivitySecondsnumber
devicestring
all | desktop | mobile
visitorstring
all | new | returning
minPageViewsinteger
frequencyDaysnumber
audienceobject
hideKnownSubscribersboolean
countriesstring[]
countriesExcludestring[]
utmobject
referrerIncludestring[]
cartobject
productPagestring
only | never
ctaLabelstring
ctaUrlstring
idstringrequired
statusstringrequired
draft | published | archived
createdAtstringrequired
shownintegerrequired
queuedintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

POSThttps://hermeticor.com/v1/site-messages

Create a content-only on-site message (draft)

Request body

application/json
namestringrequired
htmlstringrequired
stylestring
banner | modal | slide_in = banner
audiencestring
everyone | journey = everyone
targetingobject
= {}
Show child parameters
urlIncludestring[]
urlExcludestring[]
delaySecondsnumber
scrollPercentnumber
exitIntentboolean
mobileBackExitboolean
inactivitySecondsnumber
devicestring
all | desktop | mobile
visitorstring
all | new | returning
minPageViewsinteger
frequencyDaysnumber
audienceobject
Show child parameters
modestring
show | hide = show
listIdsstring[]
= []
segmentIdsstring[]
= []
hideKnownSubscribersboolean
countriesstring[]
countriesExcludestring[]
utmobject
Show child parameters
sourcestring
mediumstring
campaignstring
referrerIncludestring[]
cartobject
Show child parameters
minValuenumber
minItemsinteger
emptyboolean
productPagestring
only | never
ctaLabelstring
ctaUrlstring
{
  "name": "string",
  "html": "string",
  "style": "banner",
  "audience": "everyone",
  "targeting": {},
  "ctaLabel": "string",
  "ctaUrl": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/site-messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","html":"string","style":"banner","audience":"everyone","targeting":{},"ctaLabel":"string","ctaUrl":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "name": "string",
  "html": "string",
  "style": "banner",
  "audience": "everyone",
  "targeting": {},
  "ctaLabel": "string",
  "ctaUrl": "string",
  "id": "string",
  "status": "draft",
  "createdAt": "2024-01-01T00:00:00Z",
  "shown": 0,
  "queued": 0
}
Schema
namestringrequired
htmlstringrequired
stylestringrequired
banner | modal | slide_in = banner
audiencestringrequired
everyone | journey = everyone
targetingobjectrequired
= {}
Show child parameters
urlIncludestring[]
urlExcludestring[]
delaySecondsnumber
scrollPercentnumber
exitIntentboolean
mobileBackExitboolean
inactivitySecondsnumber
devicestring
all | desktop | mobile
visitorstring
all | new | returning
minPageViewsinteger
frequencyDaysnumber
audienceobject
Show child parameters
modestringrequired
show | hide = show
listIdsstring[]required
= []
segmentIdsstring[]required
= []
hideKnownSubscribersboolean
countriesstring[]
countriesExcludestring[]
utmobject
Show child parameters
sourcestring
mediumstring
campaignstring
referrerIncludestring[]
cartobject
Show child parameters
minValuenumber
minItemsinteger
emptyboolean
productPagestring
only | never
ctaLabelstring
ctaUrlstring
idstringrequired
statusstringrequired
draft | published | archived
createdAtstringrequired
shownintegerrequired
queuedintegerrequired
4XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

GEThttps://hermeticor.com/v1/site-messages/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/site-messages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/site-messages

4XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

DELETEhttps://hermeticor.com/v1/site-messages/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/site-messages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /ingest/v1/site-messages/{id}/shown

4XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

5XX Default Response

Same as 4XX · GET /p/f/{ref}/companies

Updated