Update a control's metadata

curl --request PATCH \
  --url https://api.vanta.com/v1/controls/{controlId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "externalId": "<string>",
  "description": "<string>",
  "note": "<string>",
  "customFields": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}
'

import requests

url = "https://api.vanta.com/v1/controls/{controlId}"

payload = {
    "name": "<string>",
    "externalId": "<string>",
    "description": "<string>",
    "note": "<string>",
    "customFields": [
        {
            "label": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    externalId: '<string>',
    description: '<string>',
    note: '<string>',
    customFields: [{label: '<string>', value: '<string>'}]
  })
};

fetch('https://api.vanta.com/v1/controls/{controlId}', 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://api.vanta.com/v1/controls/{controlId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'externalId' => '<string>',
    'description' => '<string>',
    'note' => '<string>',
    'customFields' => [
        [
                'label' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://api.vanta.com/v1/controls/{controlId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"note\": \"<string>\",\n  \"customFields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.vanta.com/v1/controls/{controlId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"note\": \"<string>\",\n  \"customFields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/controls/{controlId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"note\": \"<string>\",\n  \"customFields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a2f7e1b9d0c3f4e5a6c7b8d9",
  "externalId": "CRY-104",
  "name": "Data encryption utilized",
  "description": "Access reviews are performed to ensure that access is appropriate for the user's role and responsibilities.",
  "source": "Vanta",
  "domains": [
    "CRYPTOGRAPHIC_PROTECTIONS"
  ],
  "owner": {
    "id": "65e1efde08e8478f143a8ff9",
    "emailAddress": "example-person@email.com",
    "displayName": "Example Owner"
  },
  "note": "Remember to do by Friday",
  "numDocumentsPassing": 1,
  "numDocumentsTotal": 1,
  "numTestsPassing": 2,
  "numTestsTotal": 3,
  "status": "IN_PROGRESS",
  "role": "CONTROLLER",
  "customFields": [
    {
      "label": "Additional context",
      "value": "This control is critical for GDPR compliance"
    }
  ],
  "creationDate": null,
  "modificationDate": null
}