Update an approval policy
1 min
PATCH
http://localhost:3002//projects/{project_id}/environments/{environment_id}/policies/{policy_id}
Path Parameters
- project_idintegerrequired
- environment_idintegerrequired
- policy_idintegerrequired
Body Parameters
- bodyPolicyUpdateRequestrequired
- namestringDescription
- descriptionstringDescription
- approver_assignment_modeApproverAssignmentModeDescription
- default_preferencesPolicyDefaultPreferencesDescription
- audiencesboolean
- metricsboolean
- ramp_percboolean
- rulesboolean
- rulesetboolean
- variationsboolean
- approversPolicyApproverInput[]Description
- typestring<user | team>requiredDescriptionAlloweduserteam
- emailstringDescription
- team_idstringDescription
- notification_recipientsPolicyApproverInput[]Description
- typestring<user | team>requiredDescriptionAlloweduserteam
- emailstringDescription
- team_idstringDescription
- entitiesPolicyEntityInput[]Description
- operationstring<add | replace | remove>requiredDescriptionAllowedaddreplaceremove
- entity_keystringrequiredDescriptionMin Length1
- entity_idintegerrequiredDescription
- preferencesmap<string, boolean>Description
Responses
200
- PolicyResponse
- idintegerrequiredDescription
- namestringrequiredDescription
- descriptionstringDescription
- approver_assignment_modeApproverAssignmentModeDescription
- entity_typestring<flag | ruleset>requiredDescriptionAllowedflagruleset
- environment_idintegerrequiredDescription
- project_idintegerrequiredDescription
- is_defaultbooleanrequiredDescription
- default_preferencesPolicyDefaultPreferencesrequiredDescription
- audiencesboolean
- metricsboolean
- ramp_percboolean
- rulesboolean
- rulesetboolean
- variationsboolean
- approversPolicyApprover[]requiredDescription
- typestring<user | team>requiredDescriptionAlloweduserteam
- emailstringDescription
- team_idstringDescription
- team_namestringDescription
- notification_recipientsPolicyApprover[]Description
- typestring<user | team>requiredDescriptionAlloweduserteam
- emailstringDescription
- team_idstringDescription
- team_namestringDescription
- entitiesPolicyEntity[]requiredDescription
- idintegerrequiredDescription
- entity_idintegerrequiredDescription
- entity_keystringrequiredDescription
- typestringrequiredDescription
- preferencesmap<string, boolean>requiredDescription
- archivedbooleanrequiredDescription
- created_atstring<date-time>requiredDescriptionFormatdate-time
- updated_atstring<date-time>requiredDescriptionFormatdate-time
- revisionintegerDescription
- archivedbooleanDescription
404
- ErrorResponse
- detailsstringrequiredDescription
- statusintegerrequiredExampleDescription
422
- HTTPValidationError
- detailValidationError[]
- locobject[]requiredDescription
- msgstringrequiredDescription
- typestringrequiredDescription
- statusintegerExampleDescription
curl
curl --request PATCH \
--url http://localhost:3002//projects/{project_id}/environments/{environment_id}/policies/{policy_id} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"approvers": [
{
"type": ""
}
],
"notification_recipients": [
{
"type": ""
}
],
"entities": [
{
"operation": "",
"entity_key": "",
"entity_id": ""
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"approvers": [
{
"type": ""
}
],
"notification_recipients": [
{
"type": ""
}
],
"entities": [
{
"operation": "",
"entity_key": "",
"entity_id": ""
}
]
});
var requestOptions = {
method: 'PATCH',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("http://localhost:3002//projects/{project_id}/environments/{environment_id}/policies/{policy_id}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://localhost:3002//projects/{project_id}/environments/{environment_id}/policies/{policy_id}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"approvers": [
{
"type": ""
}
],
"notification_recipients": [
{
"type": ""
}
],
"entities": [
{
"operation": "",
"entity_key": "",
"entity_id": ""
}
]
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://localhost:3002//projects/{project_id}/environments/{environment_id}/policies/{policy_id}"
payload = json.dumps({
"approvers": [
{
"type": ""
}
],
"notification_recipients": [
{
"type": ""
}
],
"entities": [
{
"operation": "",
"entity_key": "",
"entity_id": ""
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.text)
200
// Policy updated successfully
{
"id": 0,
"name": "",
"description": "",
"approver_assignment_mode": "",
"entity_type": "",
"environment_id": 0,
"project_id": 0,
"is_default": false,
"default_preferences": {
"audiences": false,
"metrics": false,
"ramp_perc": false,
"rules": false,
"ruleset": false,
"variations": false
},
"approvers": [
{
"type": "",
"email": "",
"team_id": "",
"team_name": ""
}
],
"notification_recipients": [
{
"type": "",
"email": "",
"team_id": "",
"team_name": ""
}
],
"entities": [
{
"id": 0,
"entity_id": 0,
"entity_key": "",
"type": "",
"preferences": "",
"archived": false
}
],
"created_at": "",
"updated_at": "",
"revision": 0,
"archived": false
}404
// Policy not found
{
"details": "",
"status": 400
}422
// Validation Error
{
"detail": [
{
"loc": [
{}
],
"msg": "",
"type": ""
}
],
"status": 422
}