Skip to main content
Toggle the 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

POST https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links/{linkID}/activate
Sets active: true on the link. Response always returns active: true.

​
Authentication

​
Authorization
string
required
Bearer token using your API key. Format: Bearer cs_live_your_key

​
Path parameters

​
formID
string
required
The parent form’s unique identifier.
​
linkID
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

​
linkID
string
Unique identifier for the link.
​
formID
string
The parent form’s ID.
​
active
boolean
true after activate, false after deactivate. If the link was already in the target state, this still reflects the current value.

​
Status codes

CodeDescription
200Link is in the target state (newly toggled or already there).
401Missing or invalid API key.
403Link belongs to a different organization.
404No link found with the given ID, or not attached to the supplied formID.
500Internal error.

​
Examples

cURL
curl -X POST https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/forms/{formID}/links/{linkID}/activate \
  -H "Authorization: Bearer cs_live_your_key"
200 response
{
  "linkID": "bc033789-1ee2-4f3f-bec5-2f108c2d65ba",
  "formID": "550e8400-e29b-41d4-a716-446655440000",
  "active": true
}