Cards, prop trading & accounting

Freeze Card

Locks or unlocks the caller's own Rain card via Rain API and mirrors the status locally.

POSThttps://api.toku.com/hris/freeze-card

Not available to API keys.

curl --request POST \
  --url 'https://api.toku.com/hris/freeze-card' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rainCardId": "string",
  "freeze": true
}'
200 response
{
  "success": true,
  "status": "string"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Body

application/json

rainCardIdstringrequired

Allowed: at least 1 characters

freezebooleanrequired

Response

200Successful response
successbooleanrequired
statusstringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits