embeds

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-embeds"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/b254a28f-f717-4d18-9b46-c8bcabb6d7ff/social-card.svg?v=3e7ae33eec8b" alt="embeds" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/embed-api/{token}/journey/publish

Publish the saved draft as a new version; body.inFlight chooses stay / migrate / exit for enrollments already inside

Parameters

tokenstringpathrequired

Request body

application/json
inFlightstring
stay | migrate | exit = stay
nodeMapobject
= {}
{
  "inFlight": "stay",
  "nodeMap": {}
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/embed-api/{token}/journey/publish" \
  -H "Content-Type: application/json" \
  -d '{"inFlight":"stay","nodeMap":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "workflow": {
    "id": "string",
    "name": "string",
    "purpose": "marketing",
    "mode": "journey",
    "status": "draft",
    "publishedVersionId": "string",
    "folder": "string",
    "tags": [
      "string"
    ],
    "color": "string",
    "draftGraph": {},
    "draftTriggers": {},
    "draftSettings": {},
    "ab": {
      "variants": [
        {
          "versionId": "string",
          "weight": 0
        }
      ],
      "startedAt": "2024-01-01T00:00:00Z"
    },
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  },
  "version": {
    "id": "string",
    "workflowId": "string",
    "n": 0,
    "graph": {},
    "trigger": {},
    "settings": {},
    "checksum": "string",
    "publishedAt": "2024-01-01T00:00:00Z",
    "publishedBy": "string"
  },
  "moved": 0,
  "exited": 0
}
Schema
workflowobjectrequired
Show child parameters
idstringrequired
namestringrequired
purposestringrequired
marketing | prospecting | transactional | operational
modestringrequired
journey | sequence
statusstringrequired
draft | live | paused | archived
publishedVersionIdstringrequired
folderstringrequired
tagsstring[]required
colorstring
draftGraphrequired
draftTriggersrequired
draftSettingsrequired
abobject
Show child parameters
variantsVariantsItem3[]required
startedAtstringrequired
createdAtstringrequired
updatedAtstringrequired
versionobjectrequired
Show child parameters
idstringrequired
workflowIdstringrequired
nintegerrequired
graphrequired
triggerrequired
settingsrequired
checksumstringrequired
publishedAtstringrequired
publishedBystringrequired
movedintegerrequired
exitedintegerrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/embed-api/{token}/journey/publish

Updated