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>
PATCHhttps://hermeticor.com/v1/site-messages/{id}

Edit, publish (status) or archive

Parameters

idstringpathrequired

Request body

application/json
namestring
htmlstring
stylestring
banner | modal | slide_in
audiencestring
everyone | journey
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
statusstring
draft | published | archived
{
  "name": "string",
  "html": "string",
  "style": "banner",
  "audience": "everyone",
  "targeting": {
    "urlInclude": [
      "string"
    ],
    "urlExclude": [
      "string"
    ],
    "delaySeconds": 0,
    "scrollPercent": 0,
    "exitIntent": true,
    "mobileBackExit": true,
    "inactivitySeconds": 0,
    "device": "all",
    "visitor": "all",
    "minPageViews": 0,
    "frequencyDays": 0,
    "audience": {
      "mode": "show",
      "listIds": [],
      "segmentIds": []
    },
    "hideKnownSubscribers": true,
    "countries": [
      "string"
    ],
    "countriesExclude": [
      "string"
    ],
    "utm": {
      "source": "string",
      "medium": "string",
      "campaign": "string"
    },
    "referrerInclude": [
      "string"
    ],
    "cart": {
      "minValue": 0,
      "minItems": 0,
      "empty": true
    },
    "productPage": "only"
  },
  "ctaLabel": "string",
  "ctaUrl": "string",
  "status": "draft"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/site-messages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","html":"string","style":"banner","audience":"everyone","targeting":{"urlInclude":["string"],"urlExclude":["string"],"delaySeconds":0,"scrollPercent":0,"exitIntent":true,"mobileBackExit":true,"inactivitySeconds":0,"device":"all","visitor":"all","minPageViews":0,"frequencyDays":0,"audience":{"mode":"show","listIds":[],"segmentIds":[]},"hideKnownSubscribers":true,"countries":["string"],"countriesExclude":["string"],"utm":{"source":"string","medium":"string","campaign":"string"},"referrerInclude":["string"],"cart":{"minValue":0,"minItems":0,"empty":true},"productPage":"only"},"ctaLabel":"string","ctaUrl":"string","status":"draft"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 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
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PATCH /v1/site-messages/{id}

Updated