Modules

Update module

patch/api/v1/agents/{agent}/steps/{stepId}

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/agents/{agent}/steps/{stepId}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

configobject

Replacement block configuration object for this step.

rulesstring nullable

Plain-language guidance the agent follows for this step; null clears it. Stored as config.rules and wins over config.rules when both are sent. For Next Steps (signup) this is option 1's guidance.

stepLabelstring

Display label for the step (synced to the agent's step-name list).

Response

Success.

dataobject required

A sales-process step (module): id, stepNumber, appType, config (block-specific, with catalog/signup data hydrated), rules (the guidance the agent follows — always equal to config.rules), and editor metadata.

Changes

No recorded changes to this operation across all 1 revision of this API.