Journey

Appearance

E-Form API Documentation ​

Overview ​

The E-Form API provides endpoints for managing electronic forms in the system.

Bootstrap ​

GET https://api.journeyid.com/e-form/bootstrap

Retrieves the initial configuration for e-form operations.

Request Body ​

json
{
  "phoneNumber": "string (E.164 format)",
  "customerRef": "string (optional)",
  "sessionRef": "string (optional)"
}

Response ​

json
{
  "customers": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ]
}

Send Form ​

POST https://api.journeyid.com/e-form/send

Sends an electronic form to specified recipients.

Request Body ​

json
{
  // Common request fields
  "sessionRef": "string",
  "customerRef": "string (optional)",
  "phoneNumber": "string (E.164 format)",

  // App specific fields
  "formId": "string (uuid)",
}

Response ​

json
{
  "requestId": "string",
  "wsToken": "string"
}