> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CommerceAgentConfigInput

> Playbook settings to stage in the draft. Only the fields you pass change: a field you leave out keeps its stored value, and a group must set at least one field. Null is accepted only for `recontactCooldownHours` and `discount.discountCodeId`; everywhere else it is refused, so leave the field out. `brandName`, `brandBio` and `excludeSmsProviderUnsubscribers` go live at once, so a draft cannot hold them and passing any of them is refused.

**brandBio** `String`

Not accepted in a draft: it goes live at once, so passing it is refused (LIVE\_ONLY\_FIELD).

**brandName** `String`

Not accepted in a draft: it goes live at once, so passing it is refused (LIVE\_ONLY\_FIELD).

**channels** `[CommerceAgentConfigChannelsInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channels-input)`

Outreach channels.

**fields**

**email** `[CommerceAgentConfigChannelInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channel-input)`

Email.

**fields**

**enabled** `Boolean`

Switch the channel on or off. Leave it out to keep the stored value. Not null.

**extendedOutreach** `[CommerceAgentConfigChannelInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channel-input)`

Extended outreach. Turning the agent on (`enabled` true while the draft's agent is off) also switches it on, unless you set this too.

**fields**

**enabled** `Boolean`

Switch the channel on or off. Leave it out to keep the stored value. Not null.

**iMessage** `[CommerceAgentConfigChannelInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channel-input)`

iMessage.

**fields**

**enabled** `Boolean`

Switch the channel on or off. Leave it out to keep the stored value. Not null.

**rcs** `[CommerceAgentConfigChannelInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channel-input)`

Rich text messages (RCS).

**fields**

**enabled** `Boolean`

Switch the channel on or off. Leave it out to keep the stored value. Not null.

**sms** `[CommerceAgentConfigChannelInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channel-input)`

Text messages.

**fields**

**enabled** `Boolean`

Switch the channel on or off. Leave it out to keep the stored value. Not null.

**discount** `[CommerceAgentConfigDiscountInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-discount-input)`

The discount the agent may offer.

**fields**

**discountCodeId** `ID`

The DiscountCode the agent may offer: an id from `discountCodes`. Leave it out to keep the stored value. Null unlinks it.

**offered** `Boolean`

Whether the agent offers the discount. False keeps the link and stops the offers. Leave it out to keep the stored value. Not null.

**proclivity** `[CommerceAgentDiscountProclivity](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-discount-proclivity)`

How readily the agent offers the discount. Leave it out to keep the stored value. Not null.

**enabled** `Boolean`

Whether the Commerce Agent is on. Turning it on (true while the draft's agent is off) also switches extended outreach on, unless `channels.extendedOutreach` is set or the store's plan has none; true for an agent already on changes nothing. Leave it out to keep the stored value. Not null.

**escalation** `[CommerceAgentConfigEscalationInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-escalation-input)`

Handing conversations to the support team.

**fields**

**contactEmail** `String`

The email address the agent tells shoppers to write to, at most 254 characters. Leave it out to keep the stored value. Not null: an empty string clears it. Left out of the developer log.

**escalateToSupport** `Boolean`

Whether the agent may hand a conversation to support. Leave it out to keep the stored value. Not null.

**excludeSmsProviderUnsubscribers** `Boolean`

Not accepted in a draft: it goes live at once, so passing it is refused (LIVE\_ONLY\_FIELD).

**guidelines** `[String!]`

The whole list of guidelines, in order: at most 20, each at most 500 characters. It replaces the stored list; an empty list clears it. Leave it out to keep the stored value. Not null.

**personaName** `String`

The name the agent goes by, at most 64 characters. Leave it out to keep the stored value. Not null: an empty string clears it.

**recontactCooldownHours** `Int`

Hours before the agent contacts the same shopper again, from 1 to 8760. Leave it out to keep the stored value. Null goes back to the default.

**repliesEnabled** `Boolean`

Whether the agent replies to shoppers who write back. Leave it out to keep the stored value. Not null.

**returnWindowGrace** `[CommerceAgentConfigReturnWindowGraceInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-return-window-grace-input)`

Late-return cutoffs.

**fields**

**agentDays** `Int`

Days past the window the agent may accept a return on its own. Leave it out to keep the stored value. Not null.

**teamReviewDays** `Int`

Days past the window a return goes to the team for review. At least `agentDays`. Leave it out to keep the stored value. Not null.

**tone** `[CommerceAgentConfigToneInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-tone-input)`

Tone and voice.

**fields**

**formalityCasualness** `[CommerceAgentToneRangeInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-tone-range-input)`

From formal (1) to casual (5).

**fields**

**max** `Int!` *required*

The high end, from 1 to 5.

**min** `Int!` *required*

The low end, from 1 to 5.

**matterOfFactEnthusiasm** `[CommerceAgentToneRangeInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-tone-range-input)`

From matter-of-fact (1) to enthusiastic (5).

**fields**

**max** `Int!` *required*

The high end, from 1 to 5.

**min** `Int!` *required*

The low end, from 1 to 5.

**respectfulnessIrreverence** `[CommerceAgentToneRangeInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-tone-range-input)`

From respectful (1) to irreverent (5).

**fields**

**max** `Int!` *required*

The high end, from 1 to 5.

**min** `Int!` *required*

The low end, from 1 to 5.

**seriousnessHumor** `[CommerceAgentToneRangeInput](/docs/api-reference/v3/reference/commerce-agent/commerce-agent-tone-range-input)`

From serious (1) to humorous (5).

**fields**

**max** `Int!` *required*

The high end, from 1 to 5.

**min** `Int!` *required*

The low end, from 1 to 5.

**voiceInstructions** `String`

Free-text voice instructions, at most 500 characters. Leave it out to keep the stored value. Not null: an empty string clears them.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.