Update a relationship
curl --request PUT \
--url https://app.visotrust.com/api/v1/relationships \
--header 'Content-Type: application/json' \
--data '
{
"id": 123,
"name": "<string>",
"homepage": "<string>",
"description": "<string>",
"contextTypes": [
{
"name": "<string>"
}
],
"dataTypes": [
{
"name": "<string>"
}
],
"businessOwnerFirstName": "<string>",
"businessOwnerLastName": "<string>",
"businessOwnerEmail": "<string>",
"assessmentLeadFirstName": "<string>",
"assessmentLeadLastName": "<string>",
"assessmentLeadEmail": "<string>",
"tags": [
"<string>"
],
"externalId": "<string>",
"productName": "<string>",
"tier": 3
}
'import requests
url = "https://app.visotrust.com/api/v1/relationships"
payload = {
"id": 123,
"name": "<string>",
"homepage": "<string>",
"description": "<string>",
"contextTypes": [{ "name": "<string>" }],
"dataTypes": [{ "name": "<string>" }],
"businessOwnerFirstName": "<string>",
"businessOwnerLastName": "<string>",
"businessOwnerEmail": "<string>",
"assessmentLeadFirstName": "<string>",
"assessmentLeadLastName": "<string>",
"assessmentLeadEmail": "<string>",
"tags": ["<string>"],
"externalId": "<string>",
"productName": "<string>",
"tier": 3
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: 123,
name: '<string>',
homepage: '<string>',
description: '<string>',
contextTypes: [{name: '<string>'}],
dataTypes: [{name: '<string>'}],
businessOwnerFirstName: '<string>',
businessOwnerLastName: '<string>',
businessOwnerEmail: '<string>',
assessmentLeadFirstName: '<string>',
assessmentLeadLastName: '<string>',
assessmentLeadEmail: '<string>',
tags: ['<string>'],
externalId: '<string>',
productName: '<string>',
tier: 3
})
};
fetch('https://app.visotrust.com/api/v1/relationships', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.visotrust.com/api/v1/relationships",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 123,
'name' => '<string>',
'homepage' => '<string>',
'description' => '<string>',
'contextTypes' => [
[
'name' => '<string>'
]
],
'dataTypes' => [
[
'name' => '<string>'
]
],
'businessOwnerFirstName' => '<string>',
'businessOwnerLastName' => '<string>',
'businessOwnerEmail' => '<string>',
'assessmentLeadFirstName' => '<string>',
'assessmentLeadLastName' => '<string>',
'assessmentLeadEmail' => '<string>',
'tags' => [
'<string>'
],
'externalId' => '<string>',
'productName' => '<string>',
'tier' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.visotrust.com/api/v1/relationships"
payload := strings.NewReader("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"homepage\": \"<string>\",\n \"description\": \"<string>\",\n \"contextTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"dataTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"businessOwnerFirstName\": \"<string>\",\n \"businessOwnerLastName\": \"<string>\",\n \"businessOwnerEmail\": \"<string>\",\n \"assessmentLeadFirstName\": \"<string>\",\n \"assessmentLeadLastName\": \"<string>\",\n \"assessmentLeadEmail\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"externalId\": \"<string>\",\n \"productName\": \"<string>\",\n \"tier\": 3\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.visotrust.com/api/v1/relationships")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"homepage\": \"<string>\",\n \"description\": \"<string>\",\n \"contextTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"dataTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"businessOwnerFirstName\": \"<string>\",\n \"businessOwnerLastName\": \"<string>\",\n \"businessOwnerEmail\": \"<string>\",\n \"assessmentLeadFirstName\": \"<string>\",\n \"assessmentLeadLastName\": \"<string>\",\n \"assessmentLeadEmail\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"externalId\": \"<string>\",\n \"productName\": \"<string>\",\n \"tier\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.visotrust.com/api/v1/relationships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 123,\n \"name\": \"<string>\",\n \"homepage\": \"<string>\",\n \"description\": \"<string>\",\n \"contextTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"dataTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"businessOwnerFirstName\": \"<string>\",\n \"businessOwnerLastName\": \"<string>\",\n \"businessOwnerEmail\": \"<string>\",\n \"assessmentLeadFirstName\": \"<string>\",\n \"assessmentLeadLastName\": \"<string>\",\n \"assessmentLeadEmail\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"externalId\": \"<string>\",\n \"productName\": \"<string>\",\n \"tier\": 3\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": 123,
"homepage": "<string>",
"description": "<string>",
"businessUnit": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"recertificationDate": "2023-11-07T05:31:56Z",
"inherentRiskScore": 123,
"residualRiskScore": 123,
"isTransitional": true,
"contextTypes": [
{
"name": "<string>"
}
],
"dataTypes": [
{
"name": "<string>"
}
],
"businessOwner": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
},
"assessmentLead": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
},
"subscribers": [
{
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
}
],
"primaryContact": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"tags": [
"<string>"
],
"tier": "<string>",
"complianceStandards": [],
"latestAssessment": {
"id": 123,
"sentToEmail": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"summary": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"completedDate": "2023-11-07T05:31:56Z",
"requestedAuditTypes": [
"<string>"
],
"aiProcessingOnly": true,
"sentToFirstName": "<string>",
"sentToLastName": "<string>",
"assessmentType": "<string>",
"statusHistories": [
{
"date": "2023-11-07T05:31:56Z"
}
],
"recommendations": [
{
"description": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
],
"updatedDate": "2023-11-07T05:31:56Z",
"phaseDate": "2023-11-07T05:31:56Z",
"sentBy": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
},
"requestedArtifactCollection": true
},
"externalId": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productName": "<string>",
"dimensionCoverage": [
{
"dimension": "<string>",
"inScope": true,
"coverage": "<string>",
"coveragePercentage": "<string>"
}
]
}Relationships
Update a relationship
PUT
/
api
/
v1
/
relationships
Update a relationship
curl --request PUT \
--url https://app.visotrust.com/api/v1/relationships \
--header 'Content-Type: application/json' \
--data '
{
"id": 123,
"name": "<string>",
"homepage": "<string>",
"description": "<string>",
"contextTypes": [
{
"name": "<string>"
}
],
"dataTypes": [
{
"name": "<string>"
}
],
"businessOwnerFirstName": "<string>",
"businessOwnerLastName": "<string>",
"businessOwnerEmail": "<string>",
"assessmentLeadFirstName": "<string>",
"assessmentLeadLastName": "<string>",
"assessmentLeadEmail": "<string>",
"tags": [
"<string>"
],
"externalId": "<string>",
"productName": "<string>",
"tier": 3
}
'import requests
url = "https://app.visotrust.com/api/v1/relationships"
payload = {
"id": 123,
"name": "<string>",
"homepage": "<string>",
"description": "<string>",
"contextTypes": [{ "name": "<string>" }],
"dataTypes": [{ "name": "<string>" }],
"businessOwnerFirstName": "<string>",
"businessOwnerLastName": "<string>",
"businessOwnerEmail": "<string>",
"assessmentLeadFirstName": "<string>",
"assessmentLeadLastName": "<string>",
"assessmentLeadEmail": "<string>",
"tags": ["<string>"],
"externalId": "<string>",
"productName": "<string>",
"tier": 3
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: 123,
name: '<string>',
homepage: '<string>',
description: '<string>',
contextTypes: [{name: '<string>'}],
dataTypes: [{name: '<string>'}],
businessOwnerFirstName: '<string>',
businessOwnerLastName: '<string>',
businessOwnerEmail: '<string>',
assessmentLeadFirstName: '<string>',
assessmentLeadLastName: '<string>',
assessmentLeadEmail: '<string>',
tags: ['<string>'],
externalId: '<string>',
productName: '<string>',
tier: 3
})
};
fetch('https://app.visotrust.com/api/v1/relationships', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.visotrust.com/api/v1/relationships",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 123,
'name' => '<string>',
'homepage' => '<string>',
'description' => '<string>',
'contextTypes' => [
[
'name' => '<string>'
]
],
'dataTypes' => [
[
'name' => '<string>'
]
],
'businessOwnerFirstName' => '<string>',
'businessOwnerLastName' => '<string>',
'businessOwnerEmail' => '<string>',
'assessmentLeadFirstName' => '<string>',
'assessmentLeadLastName' => '<string>',
'assessmentLeadEmail' => '<string>',
'tags' => [
'<string>'
],
'externalId' => '<string>',
'productName' => '<string>',
'tier' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.visotrust.com/api/v1/relationships"
payload := strings.NewReader("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"homepage\": \"<string>\",\n \"description\": \"<string>\",\n \"contextTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"dataTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"businessOwnerFirstName\": \"<string>\",\n \"businessOwnerLastName\": \"<string>\",\n \"businessOwnerEmail\": \"<string>\",\n \"assessmentLeadFirstName\": \"<string>\",\n \"assessmentLeadLastName\": \"<string>\",\n \"assessmentLeadEmail\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"externalId\": \"<string>\",\n \"productName\": \"<string>\",\n \"tier\": 3\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.visotrust.com/api/v1/relationships")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"homepage\": \"<string>\",\n \"description\": \"<string>\",\n \"contextTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"dataTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"businessOwnerFirstName\": \"<string>\",\n \"businessOwnerLastName\": \"<string>\",\n \"businessOwnerEmail\": \"<string>\",\n \"assessmentLeadFirstName\": \"<string>\",\n \"assessmentLeadLastName\": \"<string>\",\n \"assessmentLeadEmail\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"externalId\": \"<string>\",\n \"productName\": \"<string>\",\n \"tier\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.visotrust.com/api/v1/relationships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 123,\n \"name\": \"<string>\",\n \"homepage\": \"<string>\",\n \"description\": \"<string>\",\n \"contextTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"dataTypes\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"businessOwnerFirstName\": \"<string>\",\n \"businessOwnerLastName\": \"<string>\",\n \"businessOwnerEmail\": \"<string>\",\n \"assessmentLeadFirstName\": \"<string>\",\n \"assessmentLeadLastName\": \"<string>\",\n \"assessmentLeadEmail\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"externalId\": \"<string>\",\n \"productName\": \"<string>\",\n \"tier\": 3\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": 123,
"homepage": "<string>",
"description": "<string>",
"businessUnit": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"recertificationDate": "2023-11-07T05:31:56Z",
"inherentRiskScore": 123,
"residualRiskScore": 123,
"isTransitional": true,
"contextTypes": [
{
"name": "<string>"
}
],
"dataTypes": [
{
"name": "<string>"
}
],
"businessOwner": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
},
"assessmentLead": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
},
"subscribers": [
{
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
}
],
"primaryContact": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"tags": [
"<string>"
],
"tier": "<string>",
"complianceStandards": [],
"latestAssessment": {
"id": 123,
"sentToEmail": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"summary": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"completedDate": "2023-11-07T05:31:56Z",
"requestedAuditTypes": [
"<string>"
],
"aiProcessingOnly": true,
"sentToFirstName": "<string>",
"sentToLastName": "<string>",
"assessmentType": "<string>",
"statusHistories": [
{
"date": "2023-11-07T05:31:56Z"
}
],
"recommendations": [
{
"description": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
],
"updatedDate": "2023-11-07T05:31:56Z",
"phaseDate": "2023-11-07T05:31:56Z",
"sentBy": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessUnit": "<string>"
},
"requestedArtifactCollection": true
},
"externalId": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productName": "<string>",
"dimensionCoverage": [
{
"dimension": "<string>",
"inScope": true,
"coverage": "<string>",
"coveragePercentage": "<string>"
}
]
}Body
application/json
Pattern:
(https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|(?!(.*www\.){1})[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9]+\.[^\s]{2,}|www\.[a-zA-Z0-9]+\.[^\s]{2,})|Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
255Required range:
1 <= x <= 5Response
200 - application/json
OK
Available options:
ARCHIVED, NOT_ONBOARDED, ONBOARDED, PURGED Available options:
NO_CONTEXT, LOW, MEDIUM, HIGH, EXTREME Available options:
NO_CONTEXT, LOW, MEDIUM, HIGH, EXTREME Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
MANUAL, AUTOMATIC, NONE Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
C5, CCPA, CSA_STAR, CSA_LEVEL2, FEDRAMP, GDPR, GLBA, HIPAA, HITRUST, ISO27001, ISO27017, ISO27018, ISO27701, ISO21434, ISO22301, ISO42001, ISOIEC_2700127002, ISOIEC_2701727002, ISOIEC_2701827002, PCIDSS, PRIVACY_SHIELD, SOC1, SOC2, SOC3, TISAXREPORTLEVEL3 Show child attributes
Show child attributes
Available options:
RISK_ACCEPTED, REVIEW_NEEDED, REMEDIATION_REQUESTED Show child attributes
Show child attributes
⌘I