Skip to main content
PATCH
Update agent file
Send label, agent_instruction, or both:
  • The @handle never changes, so instructions and rules that mention it keep working after a rename.
  • The file belongs to the account: the new name and instructions apply to every agent that sends it. Tell the person before you change a file that other agents also use.
  • Values are trimmed and can be up to 4000 characters.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

File ID, from List files. A malformed ID returns 400 Validation error.

Body

application/json

Send at least one of label and agent_instruction. Values are trimmed before they are checked and saved.

label
string

New name for the file. Send "" to clear it and show the filename.

Maximum string length: 4000
agent_instruction
string

When the agent should send this file. Cannot be empty.

Required string length: 1 - 4000

Response

The updated file.

success
enum<boolean>
required
Available options:
true
file
object
required

A file your agents can send to leads. Files belong to the account, so one file and its sending instructions are shared by every agent that sends it.

Last modified on September 29, 2026