Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global_Ref.html">Global Unlock Sample for sample code.
http := chilkat.NewHttp()
var success bool
http.SetBasicAuth(true)
http.SetLogin("{{secretId}}")
http.SetPassword("{{secretPassword}}")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "password": "password",
// "password2": "pin",
// "token": "1234ab",
// "encryption_key": "customencryptionkey",
// "username_type": "001",
// "certificate": "1234567890abcd=",
// "private_key": "1234567890abcd="
// }
json := chilkat.NewJsonObject()
json.UpdateString("password","password")
json.UpdateString("password2","pin")
json.UpdateString("token","1234ab")
json.UpdateString("encryption_key","customencryptionkey")
json.UpdateString("username_type","001")
json.UpdateString("certificate","1234567890abcd=")
json.UpdateString("private_key","1234567890abcd=")
http.SetRequestHeader("Content-Type","application/json")
sbRequestBody := chilkat.NewStringBuilder()
json.EmitSb(sbRequestBody)
resp := http.PTextSb("PUT","https://domain.com/api/links/:id/",sbRequestBody,"utf-8","application/json",false,false)
if http.LastMethodSuccess() == false {
fmt.Println(http.LastErrorText())
http.DisposeHttp()
json.DisposeJsonObject()
sbRequestBody.DisposeStringBuilder()
return
}
sbResponseBody := chilkat.NewStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp := chilkat.NewJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.SetEmitCompact(false)
fmt.Println("Response Body:")
fmt.Println(*jResp.Emit())
respStatusCode := resp.StatusCode()
fmt.Println("Response Status Code = ", respStatusCode)
if respStatusCode >= 400 {
fmt.Println("Response Header:")
fmt.Println(resp.Header())
fmt.Println("Failed.")
resp.DisposeHttpResponse()
http.DisposeHttp()
json.DisposeJsonObject()
sbRequestBody.DisposeStringBuilder()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
return
}
resp.DisposeHttpResponse()
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "<uuid>",
// "institution": "<string>",
// "access_mode": "<string>",
// "last_accessed_at": "<dateTime>",
// "status": "<string>",
// "created_by": "<uuid>",
// "refresh_rate": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id := jResp.StringOf("id")
institution := jResp.StringOf("institution")
access_mode := jResp.StringOf("access_mode")
last_accessed_at := jResp.StringOf("last_accessed_at")
status := jResp.StringOf("status")
created_by := jResp.StringOf("created_by")
refresh_rate := jResp.StringOf("refresh_rate")
http.DisposeHttp()
json.DisposeJsonObject()
sbRequestBody.DisposeStringBuilder()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
Curl Command
curl -X PUT
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"password": "password",
"password2": "pin",
"token": "1234ab",
"encryption_key": "customencryptionkey",
"username_type": "001",
"certificate": "1234567890abcd=",
"private_key": "1234567890abcd="
}'
https://domain.com/api/links/:id/
Postman Collection Item JSON
{
"name": "Update",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"password\",\n \"password2\": \"pin\",\n \"token\": \"1234ab\",\n \"encryption_key\": \"customencryptionkey\",\n \"username_type\": \"001\",\n \"certificate\": \"1234567890abcd=\",\n \"private_key\": \"1234567890abcd=\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `link.id` you want to update."
}
]
},
"description": "Update the credentials of a specific link.\n\n✅ We recommend using our [Connect Widget in Update Mode](https://developers.belvo.com/docs/connect-widget-update-mode) to handle updating `invalid` or `token_required` links.\n"
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"institution\": \"<string>\",\n\t\"access_mode\": \"<string>\",\n\t\"last_accessed_at\": \"<dateTime>\",\n\t\"status\": \"<string>\",\n\t\"created_by\": \"<uuid>\",\n\t\"refresh_rate\": \"<string>\"\n}"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "MFA Token Required",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Precondition Required",
"code": 428,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
},
{
"name": "Unexpected Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"<string>\",\n \"password2\": \"<string>\",\n \"token\": \"<string>\",\n \"encryption_key\": \"<string>\",\n \"username_type\": \"<string>\",\n \"certificate\": \"<string>\",\n \"private_key\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/links/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
