Modules

Add a Next Steps option (for example a collect_payment option beside Book a call). Booking hours, form fields and delivery settings are copied from option 1. Saves and rebuilds the agent so the change is live.

post/api/v1/agents/{agent}/next-steps/options

Request

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

Request body

mode'book_call' | 'signup_flow' | 'collect_payment' required

book_call = book a call on the owner's calendar; signup_flow = send the customer to a sign-up link; collect_payment = Take payment: charge the quote from an earlier pricing step with Stripe.

optionNamestring

The option's name, e.g. "Pay a deposit". Empty shows "Option N". When there is more than one option, this is the choice button customers pick on the website and Page.

guidancestring nullable

Agent Guidance for this option: when to offer it and how to handle it. null clears it.

paymentRulesstring

Take payment only. Payment rules in plain words, e.g. "Collect 50% to confirm the booking; the rest on delivery". Empty = the full quote. Never a price: the amount always comes from the quote.

successMessagestring nullable

Take payment only. Shown to the customer after paying; null clears it.

signupUrlstring uri

Sign-up link only. Where the customer is sent to sign up.

buttonTextstring

The form's submit button for a Sign-up link or Take payment option (defaults "Get Started" / "Continue to payment"). A book_call option's submit button always reads "Submit".

routingEmailstring email

Who receives this option's leads. Omit to keep the current address.

Response

Success.

Changes

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