active flag on a prefilled checkout link. Activate sets active: true; deactivate sets active: false. Both are idempotent — calling on a link already in the target state returns 200 with the current row, no state change.
Deactivation is the soft-delete path — the row remains stored and visible via List Links under ?active=false, and can be re-enabled by calling activate. For permanent removal, use Delete Link.
Endpoints
- Activate
- Deactivate
active: true on the link. Response always returns active: true.Authentication
string
required
Bearer token using your API key. Format:
Bearer cs_live_your_keyPath parameters
string
required
The parent form’s unique identifier.
string
required
The link’s unique identifier.
Request body
None — the path identifies the link and the verb (activate vs deactivate) identifies the target state.Response
string
Unique identifier for the link.
string
The parent form’s ID.
boolean
true after activate, false after deactivate. If the link was already in the target state, this still reflects the current value.Status codes
Examples
- Activate
- Deactivate
cURL