Skip to main content
String
Not accepted in a draft: it goes live at once, so passing it is refused (LIVE_ONLY_FIELD).
String
Not accepted in a draft: it goes live at once, so passing it is refused (LIVE_ONLY_FIELD).
Outreach channels.
The discount the agent may offer.
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.
Handing conversations to the support team.
Boolean
Not accepted in a draft: it goes live at once, so passing it is refused (LIVE_ONLY_FIELD).
[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.
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.
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.
Boolean
Whether the agent replies to shoppers who write back. Leave it out to keep the stored value. Not null.
Late-return cutoffs.
Tone and voice.