Update Recurrence Order

Updates details of a single or multiple orders belonging to a recurring event series.

Required Roles: (one of the following)

  • customer_admin
  • customer_content_manager

The following details filters can be applied to the request:

  • Recurrence id (recurrence_id): The ID of the specific recurrence event to update.
  • Order id (order_id): The ID of the order from which all future orders will be updated. This field is required when the recurrence param is future.
  • Recurrence (recurrence): Optional parameter to control if the update should be applied to:
    • future (default): Current and all future occurrences in the series. Order ID is required with this option.
    • unfinished: Only orders in updatable statuses (created, pending_approval, pending_execution, execution_error, ready_to_connect, declined, returned).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Query Params
RecurrenceUpdateOptions | null

Recurrence update options

Body Params

Human readable name for the order

length ≤ 50

Category identifier

OrderStatusObj | null
OrderInternalStatusObj | null
UpdateRecurrenceOrderInputConn | null
Settings | null
ContactDetails | null
array | null
OrderProduct | null
array | null

Editor ids

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json