Browse the DealSleek API

DealSleek API · Marketing

Preview

Publish Landing Page

Publish a LANDING template publicly at /p/{slug}, pinning its stored content.

POST/api/v1/marketing/dispatch

Authorization

Minimum role
ManagerThe caller must hold this role or a higher one.
Action
PUBLISH_LANDING_PAGE

Headers

  • AuthorizationstringRequired

    Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.

  • X-CQRS-ActionstringRequired

    Names the command to run. Must be PUBLISH_LANDING_PAGE for this endpoint.

  • Content-TypestringRequired

    Always application/json.

  • X-Idempotency-KeystringOptional

    A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.

  • X-Correlation-IdstringOptional

    Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

  • page_iduuidRequired

    New page identity; republishing an existing slug of this tenant re-pins that page instead.

  • slugstringRequired

    No description yet.

  • template_iduuidRequired

    No description yet.

  • tenant_iduuidRequired

    No description yet.

  • binding_iduuid or nullOptional

    Tenant-owned public form binding whose embed the page serves.

  • storedobject or nullOptional

    No description yet.

    4 child fields
    • bodystringRequired

      The stored body — PUBLISH_LANDING_PAGE pins THIS, never caller HTML.

    • kindenumRequired

      Creative artifact kind. Drives the body schema (e.g. EMAIL has subject+body, AD has copy+image_url, LANDING has html). v1 stores everything as plain text in body + an optional subject for EMAIL.

      Allowed values
      • EMAIL
      • LANDING
      • BLOG
      • AD
      • SMS
    • statusenumRequired

      Template lifecycle. Active = published + usable by sequences / campaigns. Archived = read-only history.

      Allowed values
      • DRAFT
      • ACTIVE
      • ARCHIVED
    • versionintegerRequired

      No description yet.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

  • successbooleanRequired

    true when the command was applied.

  • error_messagestringRequired

    Empty when the command was applied.

  • projected_stateobjectOptional

    The record as it stands after the command.

  • event_payloadobjectOptional

    The event the command recorded.

  • insightsarray of objectOptional

    Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

  • 400X-CQRS-Action is missing or names a command this route does not accept. Send PUBLISH_LANDING_PAGE.
  • 400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
  • 401The access token is missing, expired or not valid.
  • 401L1_AUTHThe caller's role is below manager or the caller has no access to this record.
  • 403L1_POLICYA business rule refused the command. The message names the rule.
  • 409L1_IDEMPOTENCYA command with this idempotency key was already applied.
  • 409CONFLICTThe command would duplicate a record that must be unique.
  • 500L3_COMMITThe command was valid but could not be saved.
Generated from the API contract · revision 3f0c9f31a24e6a1b