Skip to main content
Updates a boundary. Each field has three states:
  • Not sent — left as it is.
  • Sent with a value — replaced.
  • Cleared — send "" for human_actor_id or agent_id to remove it, or [] for project_ids to stop narrowing the scope to particular projects.
workspace_id and custom_id cannot be changed.
Permission required: boundary:modify, plus search permission on every project, actor and agent the request names — see Permissions. Only what the request names is checked, so a rename does not need permission on what the boundary already covers.

Path Parameters

string
required
Boundary ID

Request Body

string
New display name, 1 to 255 characters.
string[]
Projects in scope. Replaces the whole list; send [] to stop narrowing the scope to particular projects.
string
ID of the actor in scope. Send "" to remove it.
string
ID of the agent whose memories are in scope. Send "" to remove it.

Response

Returns the updated boundary, in the same shape as Get Boundary. The errors are the same as for Create Boundary. The updated_at in this response is the value from before this update. Call Get Boundary to read the new one.