Update a task note

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/tasks/TASK-00012/notes/6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Client confirmed Monday.</p>' \
  -F "file=@site-visit.txt"

from exsited import build_client

client = build_client()

response = client.tasks.update_task_note(
    "TASK-00012",
    "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f",
    "<p>Client confirmed Monday.</p>",
    files={"file": open("site-visit.txt", "rb")},
)
print(response.data)

import {readFileSync} from 'node:fs';
import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.tasks.updateTaskNote(
    'TASK-00012',
    '6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f',
    '<p>Client confirmed Monday.</p>',
    {files: {file: ['site-visit.txt', readFileSync('site-visit.txt')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->tasks->updateTaskNote(
    'TASK-00012',
    '6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f',
    '<p>Client confirmed Monday.</p>',
    ['file' => ['site-visit.txt', fopen('site-visit.txt', 'r')]],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.tasks().updateTaskNote(
        "TASK-00012",
        "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f",
        "<p>Client confirmed Monday.</p>",
        Map.of("file", Path.of("site-visit.txt")),
        RequestOptions.none());
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Tasks.UpdateTaskNoteAsync(
    "TASK-00012",
    "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f",
    "<p>Client confirmed Monday.</p>",
    new Dictionary<string, object?> { ["file"] = new object?[] { "site-visit.txt", File.ReadAllBytes("site-visit.txt") } });

Console.WriteLine(response.Json);

import 'dart:io';

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.tasks.updateTaskNote(
  'TASK-00012',
  '6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f',
  '<p>Client confirmed Monday.</p>',
  files: {
    'file': ['site-visit.txt', File('site-visit.txt').readAsBytesSync()],
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"
	"os"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

file, err := os.ReadFile("site-visit.txt")
if err != nil {
	log.Fatal(err)
}
response, err := client.Tasks().UpdateTaskNote(context.Background(), "TASK-00012", "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f", "<p>Client confirmed Monday.</p>", map[string]any{"file": []any{"site-visit.txt", file}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note": {
    "id": "<string>",
    "content": "<string>"
  }
}

PATCH

tasks

{task_code}

notes

{note_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/tasks/TASK-00012/notes/6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Client confirmed Monday.</p>' \
  -F "file=@site-visit.txt"

from exsited import build_client

client = build_client()

response = client.tasks.update_task_note(
    "TASK-00012",
    "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f",
    "<p>Client confirmed Monday.</p>",
    files={"file": open("site-visit.txt", "rb")},
)
print(response.data)

import {readFileSync} from 'node:fs';
import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.tasks.updateTaskNote(
    'TASK-00012',
    '6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f',
    '<p>Client confirmed Monday.</p>',
    {files: {file: ['site-visit.txt', readFileSync('site-visit.txt')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->tasks->updateTaskNote(
    'TASK-00012',
    '6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f',
    '<p>Client confirmed Monday.</p>',
    ['file' => ['site-visit.txt', fopen('site-visit.txt', 'r')]],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.tasks().updateTaskNote(
        "TASK-00012",
        "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f",
        "<p>Client confirmed Monday.</p>",
        Map.of("file", Path.of("site-visit.txt")),
        RequestOptions.none());
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Tasks.UpdateTaskNoteAsync(
    "TASK-00012",
    "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f",
    "<p>Client confirmed Monday.</p>",
    new Dictionary<string, object?> { ["file"] = new object?[] { "site-visit.txt", File.ReadAllBytes("site-visit.txt") } });

Console.WriteLine(response.Json);

import 'dart:io';

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.tasks.updateTaskNote(
  'TASK-00012',
  '6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f',
  '<p>Client confirmed Monday.</p>',
  files: {
    'file': ['site-visit.txt', File('site-visit.txt').readAsBytesSync()],
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"
	"os"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

file, err := os.ReadFile("site-visit.txt")
if err != nil {
	log.Fatal(err)
}
response, err := client.Tasks().UpdateTaskNote(context.Background(), "TASK-00012", "6b1d3f5a-7c9e-4b2d-8f0a-1c3e5a7b9d2f", "<p>Client confirmed Monday.</p>", map[string]any{"file": []any{"site-visit.txt", file}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note": {
    "id": "<string>",
    "content": "<string>"
  }
}

Send a multipart form with the new text as note and, optionally, a file to attach, as for adding a note. The path takes the task’s code. The note comes back under note.

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.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

task_code

string

required

The task's code. The note routes look the task up by its code, and a wt_ id returns 404.

note_id

string

required

The note's id.

Body

multipart/form-data

note

string

required

The note's text, such as <p>Call the client back.</p>.

file

An optional file to attach to the note.

Response

200 - application/json

The updated note, under note.

note

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response