Set an owned proxy note; clear using an empty string
POST
/account/api/v1/proxies/noteAuthorization
| Authorization | Bearer YOUR_ARNPROXY_API_KEY |
|---|---|
| Required permission | proxy_management |
| Accept | application/json |
| Content-Type | application/json |
Parameters
| Name | Type | Description |
|---|---|---|
proxy_id | integer | Owned active proxy record ID; 1–2147483647. |
note | string | Trimmed note: at most 500 characters and the storage bounds in the read response. Empty text clears it. |
expected_revision | string | revision from this operation’s scope/settings read: 64 lowercase hex characters. |
Request body
Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally.
{
"proxy_id": "YOUR_PROXY_ID",
"note": "My application",
"expected_revision": "FROM_PROXY_NOTE_REVISION"
}Request example
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
curl --silent --show-error --header @- \
--header 'Accept: application/json' \
--connect-timeout 10 --max-time 30 \
--request POST --header 'Content-Type: application/json' \
--data-binary @request.json \
'https://www.arnproxy.com/account/api/v1/proxies/note'Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.
{"curl":"printf \u0027Authorization: Bearer %s\\n\u0027 \u0022$ARNPROXY_API_KEY\u0022 |\n curl --silent --show-error --header @- \\\n --header \u0027Accept: application\/json\u0027 \\\n --connect-timeout 10 --max-time 30 \\\n --request POST --header \u0027Content-Type: application\/json\u0027 \\\n --data-binary @request.json \\\n \u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0027","python":"import os, requests\n\nheaders = {\u0022Authorization\u0022: \u0022Bearer \u0022 + os.environ[\u0022ARNPROXY_API_KEY\u0022]}\nimport json\nwith open(\u0022request.json\u0022, encoding=\u0022utf-8\u0022) as f:\n payload = json.load(f)\nresponse = requests.post(\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0022,\n headers=headers, json=payload,\n timeout=(10, 30), allow_redirects=False\n)\nprint(response.status_code, response.text)\n# No automatic write retry.","javascript":"const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };\nconst { readFile } = await import(\u0027node:fs\/promises\u0027);\nheaders[\u0027Content-Type\u0027] = \u0027application\/json\u0027;\nconst body = await readFile(\u0027request.json\u0027, \u0027utf8\u0027);\nconst response = await fetch(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0022, {\n method: \u0027POST\u0027, headers, redirect: \u0027error\u0027,\n signal: AbortSignal.timeout(30000), body\n});\nconsole.log(response.status, await response.text());\n\/\/ A write timeout is ambiguous; query its saved operation.","php":"\u003C?php\n$headers = [\u0027Accept: application\/json\u0027,\n \u0027Authorization: Bearer \u0027.getenv(\u0027ARNPROXY_API_KEY\u0027)];\n$headers[] = \u0027Content-Type: application\/json\u0027;\n$ch = curl_init(\u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0027);\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER =\u003E true,\n CURLOPT_HTTPHEADER =\u003E $headers,\n CURLOPT_FOLLOWLOCATION =\u003E false,\n CURLOPT_SSL_VERIFYPEER =\u003E true, CURLOPT_SSL_VERIFYHOST =\u003E 2,\n CURLOPT_CONNECTTIMEOUT =\u003E 10, CURLOPT_TIMEOUT =\u003E 30,\n CURLOPT_POST =\u003E true,\n CURLOPT_POSTFIELDS =\u003E file_get_contents(\u0027request.json\u0027),\n]);\n$result = curl_exec($ch);\nif ($result === false) {\n \/\/ Do not repeat a write; use the original operation key.\n throw new RuntimeException(\u0027Transport result unknown\u0027);\n}\necho curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;\ncurl_close($ch);","go":"package main\n\nimport (\n \u0022fmt\u0022\n \u0022io\u0022\n \u0022net\/http\u0022\n \u0022os\u0022\n \u0022time\u0022\n)\n\nfunc main() {\n client := \u0026http.Client{Timeout: 30*time.Second,\n CheckRedirect: func(req *http.Request, via []*http.Request) error {\n return http.ErrUseLastResponse\n }}\n var body io.Reader\n file, err := os.Open(\u0022request.json\u0022); if err != nil { panic(err) }\n defer file.Close(); body = file\n req, err := http.NewRequest(\u0022POST\u0022, \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0022, body)\n if err != nil { panic(err) }\n req.Header.Set(\u0022Authorization\u0022, \u0022Bearer \u0022+os.Getenv(\u0022ARNPROXY_API_KEY\u0022))\n req.Header.Set(\u0022Content-Type\u0022, \u0022application\/json\u0022)\n res, err := client.Do(req); if err != nil { panic(err) }\n defer res.Body.Close()\n data, err := io.ReadAll(res.Body); if err != nil { panic(err) }\n fmt.Println(res.StatusCode, string(data))\n}","csharp":"using System;\nusing System.IO;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Text;\n\nusing var handler = new HttpClientHandler { AllowAutoRedirect = false };\nusing var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };\nusing var request = new HttpRequestMessage(HttpMethod.Post,\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0022);\nrequest.Headers.Authorization = new AuthenticationHeaderValue(\n \u0022Bearer\u0022, Environment.GetEnvironmentVariable(\u0022ARNPROXY_API_KEY\u0022));\nrequest.Content = new StringContent(\n await File.ReadAllTextAsync(\u0022request.json\u0022), Encoding.UTF8, \u0022application\/json\u0022);\nusing var response = await client.SendAsync(request);\nConsole.WriteLine((int)response.StatusCode);\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n\/\/ Never automatically retry an ambiguous write.","java":"import java.net.URI;\nimport java.net.http.*;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.*;\n\n\/\/ Inside your application method:\nvar client = HttpClient.newHttpClient();\nvar request = HttpRequest.newBuilder(URI.create(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/proxies\/note\u0022))\n .header(\u0022Authorization\u0022, \u0022Bearer \u0022 + System.getenv(\u0022ARNPROXY_API_KEY\u0022))\n .header(\u0022Accept\u0022, \u0022application\/json\u0022)\n .header(\u0022Content-Type\u0022, \u0022application\/json\u0022)\n .POST(HttpRequest.BodyPublishers.ofString(\n Files.readString(Path.of(\u0022request.json\u0022), StandardCharsets.UTF_8)))\n .build();\nvar response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode());"}Responses
200Success response
{
"ok": true,
"data": {
"state": "completed",
"changed": true,
"provider_requests": 0,
"proxy_id": 12345,
"note": "Example label",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"note_update_available": true,
"clear_with_empty_string": true,
"source": "arnproxy_records",
"maximum_length": 500,
"maximum_utf8_bytes": 2000,
"full_unicode_supported": true
},
"meta": {
"request_id": "000000000000000000000001",
"phase": "public_v1",
"source": "arnproxy_records"
}
}Response fields and types
| Name | Type | Description |
|---|---|---|
ok | boolean | Success envelope flag; on false inspect error.code. |
data | object | Operation-specific result; examples are illustrative and synthetic. |
data.state | string | Record/operation state. accepted is not delivery; completed is not a connection test. |
data.changed | boolean | Whether the note actually changed; false can mean the desired text was already present. |
data.provider_requests | integer | Operation-specific provider requests value; preserve its demonstrated type and consult the behavior notes. |
data.proxy_id | integer | Relevant ARNPROXY record ID; use it instead of the upstream internal ID. |
data.note | string | Operation-specific note value; preserve its demonstrated type and consult the behavior notes. |
data.revision | string | Freshness fingerprint to copy unchanged to the corresponding write/price confirmation. |
data.note_update_available | boolean | Operation-specific note update available value; preserve its demonstrated type and consult the behavior notes. |
data.clear_with_empty_string | boolean | Operation-specific clear with empty string value; preserve its demonstrated type and consult the behavior notes. |
data.source | string | Data source; local records and a live provider lookup are different evidence. |
data.maximum_length | integer | Operation-specific maximum length value; preserve its demonstrated type and consult the behavior notes. |
data.maximum_utf8_bytes | integer | Operation-specific maximum utf8 bytes value; preserve its demonstrated type and consult the behavior notes. |
data.full_unicode_supported | boolean | Operation-specific full unicode supported value; preserve its demonstrated type and consult the behavior notes. |
meta | object | Request correlation and data-source metadata. |
meta.request_id | string | This HTTP request’s correlation ID, not an operation key or order ID. |
meta.phase | string | Operation-specific phase value; preserve its demonstrated type and consult the behavior notes. |
meta.source | string | Data source; local records and a live provider lookup are different evidence. |
Error response
{
"ok": false,
"error": { "code": "INVALID_API_KEY" },
"meta": { "request_id": "000000000000000000000001" }
}Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →
Behavior & important notes
- Uses the existing customer-panel Proxy Note field; nothing is sent upstream. Up to 500 characters, subject to storage limits reported by GET. note="" clears it. Read proxy_note for a revision first. The same desired value returns changed:false; a different value cannot overwrite a stale revision. No Idempotency-Key is needed; re-read after an uncertain response.