Update a proposal
When a user wants to patch proposal by applying an operation on it.
Available operations
You can apply the following operations on a proposal by sending a PATCH request to the /proposals endpoint.
Apply promo code
apply_promo_code which should be associated to the specific parameter promo_code.
Here is a payload example:
{
"operation": "apply_promo_code",
"parameters": {
"promo_code": "promoCodeValue",
"partner_id": "partnerId",
"access_code": "accessCode"
}
}
Remove options
remove_options which should be associated to the specific parameter type as follows:
Here is a payload example:
{
"operation": "remove_options",
"parameters": {
"type": "CHILDCARE"
}
}
Extend persistence
extend_persistence which allows a proposal to live for up to 6 months.
Here is a payload example:
{
"operation": "extend_persistence",
"parameters": true
}
Remove promo code
remove_promo_code which should be associated to the specific parameter promo_code.
Here is a payload example:
{
"operation": "remove_promo_code",
"parameters": {
"promo_code": "promoCodeValue"
}
}
Auto Optionable
auto_optionable which allows a proposal to be converted automatically into a booking in option.
Here is a payload example:
{
"operation": "auto_optionable",
"parameters": true
}
Request
- Base URL: https://api.clubmed.com
- URL: https://api.clubmed.com/v0/proposals/{proposal_id}
- Auth: HTTP bearer
Path parameters
Proposal identifier
Headers
Language/Country, as returned by <code>GET /v0/locales</code> ; e.g. "en-US", "fr-FR", "ja-JP"
Api_key provided by ClubMed API team
Request body
Response
no_content
Changes
No recorded changes to this operation across all 1 revision of this API.