Block account capability

Prevents an account from performing the specified capability.

Successful completion triggers this notification
Account blocked/unblocked

For more information about event notifications, visit Webhooks.

Securitytilia_auth
Request
Request Body schema: application/json

Block account request

account_id
required
string (AccountIdCommon) <= 36 characters

Tilia account ID

block_capability
required
string

Prevented account capability

Possible values:

  • login: Prevents account from accessing the platform. This capability includes all other block capabilities
block_reason
required
string

Reason for issuing the block

Possible values:

  • account_close
note
string

Custom note to attach to the account

Responses
200

The request was successful

400

Invalid input

401

Unauthorized access.

500

Service unavailable or server error.

post/v2/block
Request samples
application/json
{
  • "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
  • "block_capability": "login",
  • "block_reason": "account_close",
  • "note": "Example note"
}
Response samples
application/json
{
  • "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
  • "blocks": {
    }
}