curl --request POST \
--url https://development.knotapi.com/zero-link/revoke \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_user_id": "123abc",
"card_id": "81n9al10a0ayn13"
}
'{
"revoked": 1
}{
"error_type": "INVALID_REQUEST",
"error_code": "INVALID_FIELD",
"error_message": "The external user id field is required."
}{
"error_type": "INVALID_INPUT",
"error_code": "INVALID_API_KEYS",
"error_message": "Invalid client_id or secret provided."
}{
"error_type": "INVALID_REQUEST",
"error_code": "NO_ACCESS",
"error_message": "Knot Zero is not enabled. Please contact Knot for access to this endpoint."
}{
"error_type": "RATE_LIMIT_ERROR",
"error_code": "TOO_MANY_REQUESTS",
"error_message": "Rate limit exceeded. Please retry after the time indicated in the Retry-After header.",
"retry_after": 42
}CardSwitcher
Revoke Knot Zero Links
Revoke a user’s Knot Zero links.
POST
/
zero-link
/
revoke
curl --request POST \
--url https://development.knotapi.com/zero-link/revoke \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_user_id": "123abc",
"card_id": "81n9al10a0ayn13"
}
'{
"revoked": 1
}{
"error_type": "INVALID_REQUEST",
"error_code": "INVALID_FIELD",
"error_message": "The external user id field is required."
}{
"error_type": "INVALID_INPUT",
"error_code": "INVALID_API_KEYS",
"error_message": "Invalid client_id or secret provided."
}{
"error_type": "INVALID_REQUEST",
"error_code": "NO_ACCESS",
"error_message": "Knot Zero is not enabled. Please contact Knot for access to this endpoint."
}{
"error_type": "RATE_LIMIT_ERROR",
"error_code": "TOO_MANY_REQUESTS",
"error_message": "Rate limit exceeded. Please retry after the time indicated in the Retry-After header.",
"retry_after": 42
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.
Body
application/json
The user whose links to revoke, and optionally the card.
Response
Successful request.
The number of links revoked. 0 if the user had no active links.
Example:
1
Was this page helpful?