Skip to main content
GET
Update a designation-only checkout frequency

Path Parameters

client_id
integer
required

Client id that owns the designation. The controller uses it when loading the designation name for the confirmation message.

hysform_id
integer
required

Donor HysForm id for this designation-only checkout page. It is carried through the route for checkout context.

designation_id
string
required

Configured designation checkout id from the landing page. It scopes the designation-only checkout context.

id
integer
required

Specific designation id already in the Redis cart. This key is updated in saved_designation_frequency.

frequency
integer
required

Frequency code selected by the donor. The controller stores the code and uses Donor::getFrequency() for the human-readable message.

session_id
string
required

Optional Redis frontend session id. When it is missing or expired, the endpoint creates a replacement session before saving the frequency.

Response

Designation frequency was updated in the checkout session.

message
string
Example:

"Schedule for General Fund was changed to Monthly"

status
string
Example:

"success"