Acquainto
Start free trial
← API reference

Eflows

GET/v1/eflows/{id}/embed

Retrieve embed code

The shareable link and the inline script embed, as strings ready to hand to someone. Both are built here rather than assembled by the caller, and that is the point of the route: the origin they carry is the respondent host, which no other /v1 response reports, and hostedUrl needs the internal id rather than the eflow_ one this API otherwise speaks in. A client has neither value, so a client cannot build either string — it can only build one that looks right and resolves to nothing.

The snippet is byte-identical to the one the Share screen in the app shows for the same eflow. The iframe and floating-chat-box variants are not published here; the app offers those, and this route serves the two an integration actually automates.

Requires the eflows:read scope.

Example request

curl https://api.acquainto.com/v1/eflows/eflow_abc123/embed \
  -H "Authorization: Bearer acq_live_xxxxxxxx"

Parameters

  • idpathstringrequired

    A eflow id, prefixed `eflow_`.

Responses

200Retrieve embed code
  • hostedUrlstringrequired

    The page a respondent opens directly -- share this link, or point an iframe at it. Already carries the respondent host and the id format that route accepts; do not rebuild it from the eflow id.

  • embedSnippetstringrequired

    Paste-ready HTML for the inline script embed: a container div and the widget bundle, self-mounting off its own `data-` attributes. Byte-identical to what the Share screen in the app hands out.

400The request was malformed or failed validation.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • detailsarray of object

      Present only on errors that can fail in several places at once -- the eflow content graph and personalization templates. Reporting one problem per round trip would turn fixing a 30-question flow into 30 requests.

      • pathstringrequired

        Dotted/bracketed path into the request body, e.g. `branches[0].triggerOptionId`.

      • codestringrequired

        Stable machine-readable code for this one problem.

      • messagestringrequired

        Human-readable. May change without notice.

      • lineinteger

        One-based line inside that field's own value. Personalization templates only.

      • columninteger

        One-based column inside that field's own value. Personalization templates only.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

401Missing, invalid, or revoked credential.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • detailsarray of object

      Present only on errors that can fail in several places at once -- the eflow content graph and personalization templates. Reporting one problem per round trip would turn fixing a 30-question flow into 30 requests.

      • pathstringrequired

        Dotted/bracketed path into the request body, e.g. `branches[0].triggerOptionId`.

      • codestringrequired

        Stable machine-readable code for this one problem.

      • messagestringrequired

        Human-readable. May change without notice.

      • lineinteger

        One-based line inside that field's own value. Personalization templates only.

      • columninteger

        One-based column inside that field's own value. Personalization templates only.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

403The credential lacks the scope this route requires.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • detailsarray of object

      Present only on errors that can fail in several places at once -- the eflow content graph and personalization templates. Reporting one problem per round trip would turn fixing a 30-question flow into 30 requests.

      • pathstringrequired

        Dotted/bracketed path into the request body, e.g. `branches[0].triggerOptionId`.

      • codestringrequired

        Stable machine-readable code for this one problem.

      • messagestringrequired

        Human-readable. May change without notice.

      • lineinteger

        One-based line inside that field's own value. Personalization templates only.

      • columninteger

        One-based column inside that field's own value. Personalization templates only.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

404No such resource, or it belongs to another tenant.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • detailsarray of object

      Present only on errors that can fail in several places at once -- the eflow content graph and personalization templates. Reporting one problem per round trip would turn fixing a 30-question flow into 30 requests.

      • pathstringrequired

        Dotted/bracketed path into the request body, e.g. `branches[0].triggerOptionId`.

      • codestringrequired

        Stable machine-readable code for this one problem.

      • messagestringrequired

        Human-readable. May change without notice.

      • lineinteger

        One-based line inside that field's own value. Personalization templates only.

      • columninteger

        One-based column inside that field's own value. Personalization templates only.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

429Rate limited. Retry after the interval in `Retry-After`.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • detailsarray of object

      Present only on errors that can fail in several places at once -- the eflow content graph and personalization templates. Reporting one problem per round trip would turn fixing a 30-question flow into 30 requests.

      • pathstringrequired

        Dotted/bracketed path into the request body, e.g. `branches[0].triggerOptionId`.

      • codestringrequired

        Stable machine-readable code for this one problem.

      • messagestringrequired

        Human-readable. May change without notice.

      • lineinteger

        One-based line inside that field's own value. Personalization templates only.

      • columninteger

        One-based column inside that field's own value. Personalization templates only.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

500Something failed on our side. Safe to retry.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • detailsarray of object

      Present only on errors that can fail in several places at once -- the eflow content graph and personalization templates. Reporting one problem per round trip would turn fixing a 30-question flow into 30 requests.

      • pathstringrequired

        Dotted/bracketed path into the request body, e.g. `branches[0].triggerOptionId`.

      • codestringrequired

        Stable machine-readable code for this one problem.

      • messagestringrequired

        Human-readable. May change without notice.

      • lineinteger

        One-based line inside that field's own value. Personalization templates only.

      • columninteger

        One-based column inside that field's own value. Personalization templates only.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

Browse every operation, with full request/response schemas, in the full API reference.