cURL
curl --request PATCH \
--url https://api.amdital.com/api/v1/okrs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objective": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "<string>",
"endDate": "<string>",
"progress": 0,
"status": "on-track",
"keyResults": []
}
'import requests
url = "https://api.amdital.com/api/v1/okrs/{id}"
payload = {
"objective": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "<string>",
"endDate": "<string>",
"progress": 0,
"status": "on-track",
"keyResults": []
}
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({
objective: '<string>',
ownerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
parentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
startDate: '<string>',
endDate: '<string>',
progress: 0,
status: 'on-track',
keyResults: []
})
};
fetch('https://api.amdital.com/api/v1/okrs/{id}', 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.amdital.com/api/v1/okrs/{id}",
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([
'objective' => '<string>',
'ownerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'parentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'startDate' => '<string>',
'endDate' => '<string>',
'progress' => 0,
'status' => 'on-track',
'keyResults' => [
]
]),
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.amdital.com/api/v1/okrs/{id}"
payload := strings.NewReader("{\n \"objective\": \"<string>\",\n \"ownerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"progress\": 0,\n \"status\": \"on-track\",\n \"keyResults\": []\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.amdital.com/api/v1/okrs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objective\": \"<string>\",\n \"ownerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"progress\": 0,\n \"status\": \"on-track\",\n \"keyResults\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.amdital.com/api/v1/okrs/{id}")
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 \"objective\": \"<string>\",\n \"ownerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"progress\": 0,\n \"status\": \"on-track\",\n \"keyResults\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"objective": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cadence": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"progress": "<string>",
"status": "<string>",
"keyResults": [
{}
],
"isActive": true,
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Goals
Patch apiv1okrs
PATCH
/
api
/
v1
/
okrs
/
{id}
cURL
curl --request PATCH \
--url https://api.amdital.com/api/v1/okrs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objective": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "<string>",
"endDate": "<string>",
"progress": 0,
"status": "on-track",
"keyResults": []
}
'import requests
url = "https://api.amdital.com/api/v1/okrs/{id}"
payload = {
"objective": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "<string>",
"endDate": "<string>",
"progress": 0,
"status": "on-track",
"keyResults": []
}
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({
objective: '<string>',
ownerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
parentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
startDate: '<string>',
endDate: '<string>',
progress: 0,
status: 'on-track',
keyResults: []
})
};
fetch('https://api.amdital.com/api/v1/okrs/{id}', 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.amdital.com/api/v1/okrs/{id}",
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([
'objective' => '<string>',
'ownerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'parentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'startDate' => '<string>',
'endDate' => '<string>',
'progress' => 0,
'status' => 'on-track',
'keyResults' => [
]
]),
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.amdital.com/api/v1/okrs/{id}"
payload := strings.NewReader("{\n \"objective\": \"<string>\",\n \"ownerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"progress\": 0,\n \"status\": \"on-track\",\n \"keyResults\": []\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.amdital.com/api/v1/okrs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objective\": \"<string>\",\n \"ownerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"progress\": 0,\n \"status\": \"on-track\",\n \"keyResults\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.amdital.com/api/v1/okrs/{id}")
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 \"objective\": \"<string>\",\n \"ownerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"progress\": 0,\n \"status\": \"on-track\",\n \"keyResults\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"objective": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cadence": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"progress": "<string>",
"status": "<string>",
"keyResults": [
{}
],
"isActive": true,
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Minimum string length:
1Available options:
weekly, monthly, quarterly, annual Required range:
0 <= x <= 100Available options:
on-track, at-risk, off-track, completed Show child attributes
Show child attributes
Response
200 - application/json
Success
Show child attributes
Show child attributes
Was this page helpful?