bdy integration update

View as Markdown
$bdy integration update|edit [options] <identifier>

Update an integration's notes. Credentials and settings are changed in the app Required scopes: INTEGRATION_MANAGE

ARGUMENTS
identifier
Integration identifier (required)
OPTIONS
--context <name>
Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.
--examples
Show only examples; with this flag --format accepts text, json or jsonl
--verbose
Show REST API requests, responses, timing and retries on stderr
-w, --workspace <domain>
Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE
-p, --project <name>
Project name. Can be set via variable: BUDDY_PROJECT
--scope <scope>
Force scope (WORKSPACE, PROJECT, ENVIRONMENT). By default calculated by provided options and environmental variables (--project, --environment, BUDDY_PROJECT, linked project)
--environment <identifier>
Environment identifier to scope the integration to. Resolves a workspace environment; add
--project
to point at a project environment
--note <note>
Resource note
--agent-note <note>
Note for AI agents operating on this resource; stored as agent_note and meant to be read before acting on the resource
--format <text|json>
Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")
-h, --help
display help for command

Documentation for bdy v1.25.38

Last modified on Nov 17, 2026

Examples

Set the note read by AI agents
bdy int update integration-identifier --agent-note "read-only token, use for reporting only"$
Set note of a project integration as json
bdy int update integration-identifier -p project --note "owned by team web" --format json$
Clear the agent note
bdy int update integration-identifier --agent-note ""$