Skip to content

Commit c4c4e5c

Browse files
fix: Update agent.deactivate.md
1 parent 4afea6d commit c4c4e5c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

messages/agent.deactivate.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# summary
22

3-
Deactivate an agent in the org.
3+
Deactivate an agent in an org.
44

55
# description
66

7-
An agent can be active or inactive within an org. Active agents are available in the org and can be previewed using the CLI or VS Code while inactive agents cannot.
7+
Deactivating an agent makes it unavailable to your users. To make changes to an agent, such as adding or removing topics or actions, you must deactivate it. You can't preview an agent with the "agent preview" CLI command or VS Code if it's deactivated.
8+
9+
You must know the agent's API name to deactivate it; you can either be prompted for it or you can specify it with the --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
810

911
# examples
1012

11-
- Deactivate an agent in the default target org by being prompted:
13+
- Deactivate an agent in your default target org by being prompted:
1214

1315
<%= config.bin %> <%= command.id %>
1416

15-
- Deactivate an agent by specifying the agent API name and target org:
17+
- Deactivate the agent Resort_Manager in the org with alias "my_org":
1618

1719
<%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org
1820

0 commit comments

Comments
 (0)