cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/note_groups/2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"note_group": {
"display_name": "Project team (Sydney)",
"description": "Notes for the Sydney project team."
}
}'from exsited import build_client
client = build_client()
response = client.note_groups.update_note_group(
"2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
{
"note_group": {
"display_name": "Project team (Sydney)",
"description": "Notes for the Sydney project team.",
}
},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.noteGroups.updateNoteGroup('2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9', {
note_group: {display_name: 'Project team (Sydney)', description: 'Notes for the Sydney project team.'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->noteGroups->updateNoteGroup('2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9', [
'note_group' => [
'display_name' => 'Project team (Sydney)',
'description' => 'Notes for the Sydney project team.',
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.note_groups.note_groups_dto.NoteGroupsDto.NoteGroup;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<NoteGroup> response = client.noteGroups().updateNoteGroup(
"2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
Map.of(
"note_group", Map.of(
"display_name", "Project team (Sydney)",
"description", "Notes for the Sydney project team.")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.NoteGroups.UpdateNoteGroupAsync(
"2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
new Dictionary<string, object?>
{
["note_group"] = new Dictionary<string, object?>
{
["display_name"] = "Project team (Sydney)",
["description"] = "Notes for the Sydney project team.",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.noteGroups.updateNoteGroup(
'2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
{
'note_group': {
'display_name': 'Project team (Sydney)',
'description': 'Notes for the Sydney project team.',
},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.NoteGroups().UpdateNoteGroup(context.Background(), "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", map[string]any{
"note_group": map[string]any{
"display_name": "Project team (Sydney)",
"description": "Notes for the Sydney project team.",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"note_group": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": "<unknown>",
"last_updated_by": "<unknown>",
"version": 123,
"href": "<string>",
"activity_logs": [
{}
]
}
}Note groups
Update a note group
Changes a note group and returns it.
PATCH
/
note_groups
/
{note_group_id}
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/note_groups/2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"note_group": {
"display_name": "Project team (Sydney)",
"description": "Notes for the Sydney project team."
}
}'from exsited import build_client
client = build_client()
response = client.note_groups.update_note_group(
"2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
{
"note_group": {
"display_name": "Project team (Sydney)",
"description": "Notes for the Sydney project team.",
}
},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.noteGroups.updateNoteGroup('2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9', {
note_group: {display_name: 'Project team (Sydney)', description: 'Notes for the Sydney project team.'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->noteGroups->updateNoteGroup('2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9', [
'note_group' => [
'display_name' => 'Project team (Sydney)',
'description' => 'Notes for the Sydney project team.',
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.note_groups.note_groups_dto.NoteGroupsDto.NoteGroup;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<NoteGroup> response = client.noteGroups().updateNoteGroup(
"2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
Map.of(
"note_group", Map.of(
"display_name", "Project team (Sydney)",
"description", "Notes for the Sydney project team.")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.NoteGroups.UpdateNoteGroupAsync(
"2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
new Dictionary<string, object?>
{
["note_group"] = new Dictionary<string, object?>
{
["display_name"] = "Project team (Sydney)",
["description"] = "Notes for the Sydney project team.",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.noteGroups.updateNoteGroup(
'2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
{
'note_group': {
'display_name': 'Project team (Sydney)',
'description': 'Notes for the Sydney project team.',
},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.NoteGroups().UpdateNoteGroup(context.Background(), "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", map[string]any{
"note_group": map[string]any{
"display_name": "Project team (Sydney)",
"description": "Notes for the Sydney project team.",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"note_group": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": "<unknown>",
"last_updated_by": "<unknown>",
"version": 123,
"href": "<string>",
"activity_logs": [
{}
]
}
}Send the fields to change wrapped in
note_group. The updated group comes back under note_group, and its version goes up.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The note group's id.
Body
application/json
The fields to change.
Show child attributes
Show child attributes
Response
200 - application/json
The updated note group, under note_group.
Show child attributes
Show child attributes