Submission API

• Base URL: https://submission.sls.epilot.io
• API Docs: https://docs.epilot.io/api/submission

Use this API to handle submissions entities from external sources e.g. journeys and frontends

Quick Start

# List available operations
epilot submission

# Call an operation
epilot submission createSubmission

Common Flags

Flag	Description
-p key=value	Set a named parameter
-d '{...}'	Request body JSON
-H 'Key: Value'	Custom header
-t, --token <token>	Bearer token for authentication
--profile <name>	Use a named profile
-s, --server <url>	Override server base URL
-i, --include	Include response headers in output
--json	Output raw JSON (no formatting)
-v, --verbose	Verbose output (show request details)
--jsonata <expr>	JSONata expression to transform response
--definition <file>	Override OpenAPI spec file/URL
--guided	Prompt for all parameters interactively
--no-interactive	Disable interactive prompts

Operations

Submissions

• createSubmission — Creates a submission from a public facing Journey
• getNonce — Returns { exists: boolean } along some meta data

createSubmission

Creates a submission from a public facing Journey

POST /v1/submission/submissions

Request Body

Sample Call

epilot submission createSubmission

With request body:

epilot submission createSubmission \
  -d '{
  "organization_id": "123",
  "journey_submit_id": "123",
  "source_type": "journey",
  "source_id": "ce99875f-fba9-4fe2-a8f9-afaf52059051",
  "opt_ins": [
    {
      "topic": "EMAIL_MARKETING",
      "identifier": "example@email.com",
      "meta": {}
    }
  ],
  "entities": [
    {
      "_schema": "submission",
      "description": "Submission created via API",
      "contact_first_name": "First",
      "contact_last_name": "Last",
      "contact_email": "example@submission.com",
      "request": "I would like to know more about electric vehicles",
      "files": [
        {
          "s3ref": {
            "bucket": "epilot-user-content",
            "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
          },
          "filename": "document.pdf"
        }
      ]
    }
  ],
  "_ivy_opportunity_ids": ["string"]
}'

Using stdin pipe:

cat body.json | epilot submission createSubmission

With JSONata filter:

epilot submission createSubmission --jsonata '$'

---

getNonce

Returns { exists: boolean } along some meta data

GET /v1/submission/nonce/{nonce_id}

Parameters

Name	In	Type	Required	Description
nonce_id	path	string	Yes

Sample Call

epilot submission getNonce \
  -p nonce_id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot submission getNonce 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot submission getNonce -p nonce_id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "nonce": "string",
  "submission_id": "string",
  "organization_id": "string",
  "ttl": 0,
  "exists": true
}

---