Restore a soft-deleted note

Clears deleted_at on a previously soft-deleted note. Requires the notes:write scope. 404 if the note is not visible to the API key’s entity.

POST /notes/{id}/restore

Restore a soft-deleted note

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/notes/{id}/restore \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/notes/{id}/restore"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/notes/{id}/restore', 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.arcuserp.com/v1/notes/{id}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/notes/{id}/restore"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/notes/{id}/restore")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/notes/{id}/restore")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "note",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_type": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "content_html": "<string>",
  "author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_pinned": false,
  "is_internal": true,
  "visible_to_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_source": "<string>",
  "external_id": "<string>",
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization · string · header · required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id · string<uuid> · required

Response

200

application/json

Restored note

A polymorphic note attached to any parent resource (order, account, product, vendor, etc.) via parent_type + parent_id. Notes carry operator-authored prose plus an optional rich-text rendering (content_html). Pinned notes sort to the top of their parent's timeline. Soft-delete sets deleted_at; restore clears it. Scope: notes:read / notes:write / notes:delete. Rule 23 SSOT: is_pinned is written only by canonical pinNote / unpinNote; deleted_at only by softDeleteNote / restoreNote.

id · string<uuid> · read-only

object · string

Example:

"note"

entity_id · string<uuid> · read-only

parent_type · string

Parent resource family (order, account, product, vendor, etc.). 1..30 chars.

parent_id · string<uuid>

content · string

Plain-text note body. Operator-authored.

content_html · string | null

Optional rich-text rendering of content for the UI.

author_user_id · string<uuid> | null

Cognito user id of the author. Null for API-key authored notes.

is_pinned · boolean · default: false

Pinned notes sort first within a parent.

is_internal · boolean · default: true

If false, the note is visible on the customer portal.

visible_to_account_id · string<uuid> | null

Optional Layer-2 narrowing for portal-visible notes.

external_source · string | null

Migration provenance (versa, bubble).

external_id · string | null

metadata · object

Free-form caller metadata. Default {}.

deleted_at · string<date-time> | null · read-only

Set by softDelete; cleared by restore.

created_at · string<date-time> · read-only

updated_at · string<date-time> · read-only