Update Agent Config
Merge top-level keys into an agent’s behavior config.
PATCH
Update agent behavior config
Merge behavior settings into an agent’s Only message a lead after a call when they asked (
During or after a call, the task can move the conversation to WhatsApp, SMS, iMessage or email. By default (
Send a hidden copy of the task’s emails (
Set
config object without changing prompts, stages, fields, or channel prompts.
By default, only the submitted top-level keys change and every other config key remains intact. Use replace: true only when you intentionally need to replace the complete object.
Common settings include disabled_channels, first_contact_channel, email_sender_id, and gate_outbound_to_hours.
Only message a lead after a call when they asked (channel_swap_consent)
During or after a call, the task can move the conversation to WhatsApp, SMS, iMessage or email. By default (shadow) those messages go out and Nexor only records whether the lead asked for them.
Set channel_swap_consent to enforce when the task must message a lead after a call only if the lead asked for it, or accepted the task’s offer to send it. A payment link, booking confirmation, contract, invoice or offer the lead agreed to counts as accepted. Otherwise nothing is sent, and the follow-up after the call does not send it either.
shadowornullreturns the task to the default.- Any other value is rejected with
400anderror: "INVALID_CHANNEL_SWAP_CONSENT". Nothing is saved. - Get Agent returns the effective mode as the top-level
channel_swap_consent(enforceorshadow). A duplicated task keeps the setting. enforcealso stops messages the team may expect, such as “I’ll write to you on WhatsApp” when the lead cannot talk. To stop every move to another channel, disable the channel change tool instead.
Send a hidden copy of the task’s emails (email_bcc)
Set email_bcc to a list of up to 5 email addresses when someone on your team must receive a copy of every email the task sends a lead, for example a supervisor who follows a collections task. The copy is hidden (BCC): the lead does not see those addresses.
- The copy covers the emails Nexor sends for that task. An email a person writes from the inbox is not copied, and neither is an email to a test lead.
- The setting belongs to one task (
workflowin the API). Save it on each task that needs it. - The list you send replaces the saved one. To add an address, send the complete list.
nullor[]removes the copy. - Addresses are saved trimmed, in lowercase and without duplicates. Write each one as a plain address (
name@company.com), with no display name. - An invalid list is rejected with
400anderror: "INVALID_EMAIL_BCC". Nothing is saved.reasonsays why:not_a_list,invalid_addressortoo_many_addresses. - There is no visible copy (CC) for the task’s emails.
Authorizations
Body
application/json
Last modified on November 11, 2026
Update agent behavior config