DealSleek API · Leads

Preview

Create Readiness Policy

Create readiness policy; deterministic advisory readiness, with engine-verified persisted inputs.

POST/api/v1/leads/dispatch

Authorization

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

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 CREATE_READINESS_POLICY 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

  • definitionobjectRequired

    No description yet.

    9 child fields
    • engagement_rulesarray of objectRequired

      No description yet.

      3 child fields
      • contributionnumberRequired

        Signed unitless contribution per occurrence, bounded to [-1, 1].

      • max_occurrencesintegerRequired

        No description yet.

        at least 0
      • signal_typeenumRequired

        No description yet.

        Allowed values
        • FUNDING_TRIGGER
        • DEMO_REQUEST
        • MEETING_BOOKED
        • AD_CONVERSION
        • CHAMPION_JOB_CHANGE
        • SEARCH_QUERY
        • EXEC_HIRE
        • REVIEW_SITE_COMPARISON
        • HIRING_TRIGGER
        • LINKEDIN_INTENT_TOPIC
        • PRICING_PAGE_VISIT
        • JOB_POSTING
        • COMPANY_NEWS
        • CONTENT_ENGAGEMENT
        • AD_CLICK
        • PAGE_VISIT
        • EMAIL_OPEN
        • UNSUBSCRIBED
        • CHAMPION_DEPARTURE
        DEMO_REQUEST
        Explicit demand — they asked for a demo/quote.
        MEETING_BOOKED
        A meeting is on the calendar with someone outside the tenant.
        AD_CONVERSION
        Bought / converted on a platform (pixel/CAPI/conversion API).
        CHAMPION_JOB_CHANGE
        A known champion moved to a new company. Published benchmarks put a past champion at ~3x purchase likelihood in a new role, and a new executive commits the majority of their budget inside 100 days — which is why this outranks every inferred signal below it.
        SEARCH_QUERY
        Searched a high-intent keyword (Google) — the strongest paid signal.
        EXEC_HIRE
        A new C-suite / VP appointment at a target account.
        REVIEW_SITE_COMPARISON
        Compared you against a competitor on a review site.
        HIRING_TRIGGER
        Time-sensitive account trigger.
        LINKEDIN_INTENT_TOPIC
        LinkedIn's buyer-intent topic on the account.
        PRICING_PAGE_VISIT
        Viewed a high-intent page (pricing, demo).
        JOB_POSTING
        Posted a role that implies the problem you solve.
        COMPANY_NEWS
        M&A, product launch, expansion, earnings language.
        CONTENT_ENGAGEMENT
        Engaged with content (post like/comment, doc download, video view).
        AD_CLICK
        Generic ad click.
        PAGE_VISIT
        Generic page visit.
        EMAIL_OPEN
        Email open — weak.
        UNSUBSCRIBED
        They asked not to be contacted. Persists — this is a stated preference, not a mood.
        CHAMPION_DEPARTURE
        The champion left the account. The relationship that carried the deal is gone, and nothing else about the account changed to say so.
    • fit_rulesarray of objectRequired

      No description yet.

      3 child fields
      • accepted_valuesarray of stringRequired

        No description yet.

      • fieldenumRequired

        No description yet.

        Allowed values
        • LEAD_SOURCE
        • ACCOUNT_INDUSTRY
        • ACCOUNT_EMPLOYEE_COUNT
        • ACCOUNT_TIER
        • LEAD_LIFECYCLE_STAGE
        • ACCOUNT_STATUS
        • ACCOUNT_HEADQUARTERS
        • ACCOUNT_DOMAIN
      • weightintegerRequired

        No description yet.

        at least 0
    • lookback_daysintegerRequired

      No description yet.

      at least 0
    • minimum_engagementnumberRequired

      No description yet.

    • minimum_fitnumberRequired

      No description yet.

    • namestringRequired

      No description yet.

    • valid_hoursintegerRequired

      No description yet.

      at least 0
    • profile_keystring or nullOptional

      Optional operator-named profile; omitted retains the tenant-wide policy.

    • segment_iduuid or nullOptional

      Optional, persisted Marketing LEADS-segment membership restriction.

  • tenant_iduuidRequired

    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 CREATE_READINESS_POLICY.
  • 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 49d871e9cf4ff307