Change an agent

Rename, change settings (merged into the current ones; null clears one), change channels, or pause / resume with status. Pausing also pauses the automations that work with the agent; resuming does not switch them back on. Needs a workspace owner, admin or editor.

Authorization

api-key

AuthorizationBearer <token>

Workspace API key (nim_live_...)

In: header

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

status?string

PAUSED stops the agent and pauses the automations that work with it. ACTIVE resumes the agent only; its automations stay paused until switched on again.

Value in

"ACTIVE"
"PAUSED"

config?

Settings to change, merged into the current ones. null clears a setting. Settings not sent are kept, including ones set in the app.

channelIds?array<string>

Replaces the channels the agent works on.

tags?array<string>

Replaces your labels.

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "LinkedIn Ghostwriter — Brewhaus",  "templateId": "linkedin-ghostwriter",  "templateName": "LinkedIn Ghostwriter",  "kind": "content",  "status": "ACTIVE",  "pausedReason": "CHANNEL_REMOVED",  "channelIds": [    "string"  ],  "preset": "carousel",  "config": {},  "setInApp": [    "string"  ],  "schedule": {    "cadence": "weekly",    "label": "Once a week"  },  "tags": [    "string"  ],  "createdAt": "string",  "updatedAt": "string",  "appUrl": "string"}

Empty

Authorization

Path Parameters

Request Body

Response Body

200application/json

400

403

404

422

`application/json`