POST

Freeze User

Route for users to freeze their account. Requires the user_manage scope. Session must be unlocked using the Unlock endpoint, prior to hitting this route. In the UI, call to this route is followed by a call to Logout endpoint.

Responses

200

No response body

401

Unauthorized

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

const url = 'https://app.bitgo-test.com/api/v2/user/freeze'; const options = {method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/user/freeze") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/v2/user/freeze', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/user/freeze" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.post(url, headers=headers) print(response.text)