cURL
curl --request PUT \
--url https://api.opal.dev/v1/request-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"name": "<string>",
"custom_fields": [
{
"name": "Why do you need this access?",
"description": "<string>",
"required": true,
"metadata": {}
}
]
}
'import requests
url = "https://api.opal.dev/v1/request-templates"
payload = {
"request_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"name": "<string>",
"custom_fields": [
{
"name": "Why do you need this access?",
"description": "<string>",
"required": True,
"metadata": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request_template_id: '7c86c85d-0651-43e2-a748-d69d658418e8',
name: '<string>',
custom_fields: [
{
name: 'Why do you need this access?',
description: '<string>',
required: true,
metadata: {}
}
]
})
};
fetch('https://api.opal.dev/v1/request-templates', 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.opal.dev/v1/request-templates",
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([
'request_template_id' => '7c86c85d-0651-43e2-a748-d69d658418e8',
'name' => '<string>',
'custom_fields' => [
[
'name' => 'Why do you need this access?',
'description' => '<string>',
'required' => true,
'metadata' => [
]
]
]
]),
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.opal.dev/v1/request-templates"
payload := strings.NewReader("{\n \"request_template_id\": \"7c86c85d-0651-43e2-a748-d69d658418e8\",\n \"name\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"Why do you need this access?\",\n \"description\": \"<string>\",\n \"required\": true,\n \"metadata\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.opal.dev/v1/request-templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_template_id\": \"7c86c85d-0651-43e2-a748-d69d658418e8\",\n \"name\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"Why do you need this access?\",\n \"description\": \"<string>\",\n \"required\": true,\n \"metadata\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/request-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_template_id\": \"7c86c85d-0651-43e2-a748-d69d658418e8\",\n \"name\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"Why do you need this access?\",\n \"description\": \"<string>\",\n \"required\": true,\n \"metadata\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"name": "Production access questions",
"custom_fields": [
{
"name": "Why do you need this access?",
"type": "SHORT_TEXT",
"description": "<string>",
"required": true,
"metadata": {
"callout_data": {
"severity": "WARNING",
"text": "This role grants access to production customer data."
},
"multi_choice_data": {
"options": [
"Incident response",
"Scheduled maintenance"
]
}
}
}
]
}Put request templates
Updates a request template.
PUT
/
request-templates
cURL
curl --request PUT \
--url https://api.opal.dev/v1/request-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"name": "<string>",
"custom_fields": [
{
"name": "Why do you need this access?",
"description": "<string>",
"required": true,
"metadata": {}
}
]
}
'import requests
url = "https://api.opal.dev/v1/request-templates"
payload = {
"request_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"name": "<string>",
"custom_fields": [
{
"name": "Why do you need this access?",
"description": "<string>",
"required": True,
"metadata": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request_template_id: '7c86c85d-0651-43e2-a748-d69d658418e8',
name: '<string>',
custom_fields: [
{
name: 'Why do you need this access?',
description: '<string>',
required: true,
metadata: {}
}
]
})
};
fetch('https://api.opal.dev/v1/request-templates', 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.opal.dev/v1/request-templates",
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([
'request_template_id' => '7c86c85d-0651-43e2-a748-d69d658418e8',
'name' => '<string>',
'custom_fields' => [
[
'name' => 'Why do you need this access?',
'description' => '<string>',
'required' => true,
'metadata' => [
]
]
]
]),
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.opal.dev/v1/request-templates"
payload := strings.NewReader("{\n \"request_template_id\": \"7c86c85d-0651-43e2-a748-d69d658418e8\",\n \"name\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"Why do you need this access?\",\n \"description\": \"<string>\",\n \"required\": true,\n \"metadata\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.opal.dev/v1/request-templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_template_id\": \"7c86c85d-0651-43e2-a748-d69d658418e8\",\n \"name\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"Why do you need this access?\",\n \"description\": \"<string>\",\n \"required\": true,\n \"metadata\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/request-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_template_id\": \"7c86c85d-0651-43e2-a748-d69d658418e8\",\n \"name\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"Why do you need this access?\",\n \"description\": \"<string>\",\n \"required\": true,\n \"metadata\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_template_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
"name": "Production access questions",
"custom_fields": [
{
"name": "Why do you need this access?",
"type": "SHORT_TEXT",
"description": "<string>",
"required": true,
"metadata": {
"callout_data": {
"severity": "WARNING",
"text": "This role grants access to production customer data."
},
"multi_choice_data": {
"options": [
"Incident response",
"Scheduled maintenance"
]
}
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Request template to be updated
Information for updating a request template. Omitted properties are left unchanged, but custom_fields replaces the template's fields wholesale when provided.
Response
200 - application/json
The request template just updated.
A template describing what a requester is asked when requesting access.
The ID of the request template.
Example:
"7c86c85d-0651-43e2-a748-d69d658418e8"
The name of the request template.
Example:
"Production access questions"
The fields on this template, in the order they are shown.
Show child attributes
Show child attributes
Last modified on August 26, 2026
Was this page helpful?
⌘I