FruxonDocs
Agent NetworkGraph

Replaces an email channel's settings.

A full replace of the editable settings; the first save creates them. Send the `version` last read (0 for settings never saved). Any other version means they changed since, and is refused with 409 and `code``EMAIL_SETTINGS_CHANGED`, so the newer settings are reloaded rather than overwritten. Recipient-filter addresses must be plain addresses and are stored lower-cased and without duplicates. `activationState` and `activatedAtMs` are read-only. An entry point that is not an Email (Gmail) channel is reported as not found.

PUT
/v1/tenants/{tenant}/networks/{network}/entryPoints/{entryPoint}/emailSettings
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

network*string

The owning Network id.

Formatuuid
entryPoint*string

The email channel's entry-point id.

Formatuuid
tenant*string

The tenant identifier

The settings to store, and the version they were edited from.

replyMode?string

DRAFT leaves each reply as a draft in the Gmail thread for a person to review and send; AUTO_SEND sends it. Group mode (UpdateEmailChannelSettingsRequest.GroupAddress) takes DRAFT only: the channel cannot yet tell the team's own mail to the group from a customer's, so Auto-send would answer teammates.

Value in"UNSPECIFIED" | "DRAFT" | "AUTO_SEND"
recipientFilter?|null

Answer only mail addressed (To, Cc or Delivered-To) to one of these addresses, such as support@acme.com on a mailbox that receives other mail too. Plain addresses only, at most 20; they are stored lower-cased and without duplicates. Null or empty answers mail to any address.

groupAddress?string|null

Group mode: the Google Group this mailbox answers for, such as support@acme.com, when the connected mailbox is a member account the group delivers to. It must be one plain address, a verified "Send mail as" address of the connected mailbox (add it in Gmail first), and not the mailbox's own address. Mail the group delivers is then answered rather than withheld as list mail, and mail not addressed to the group (or to the recipient filter) is not answered. Null or blank for an ordinary mailbox.

staffFromMailboxDomain?boolean|null

Whether anyone writing from the mailbox's own domain counts as the team rather than a customer. Absent means the default: true with a UpdateEmailChannelSettingsRequest.GroupAddress, false without. Saved now; the staff detection that reads it is not live yet.

staffAddresses?|null

More addresses whose mail counts as the team's, such as a teammate on another domain. Plain addresses only, at most 50; stored lower-cased and without duplicates. Null or empty for none. Saved now; the staff detection that reads it is not live yet.

signature?string|null

Plain text added to each reply, at most 2 KB in UTF-8. Null or blank for none.

mailboxDailyRunLimit?integer

The most agent runs the mailbox may start per day, from 1 to 5,000.

Formatint32
version?integer

The version of the settings this change was made from, as last read. 0 for a channel whose settings were never saved. Any other value than the current one is refused with 409.

Formatint64
[key: string]?never

Response Body

curl -X PUT "https://api.fruxon.com/v1/tenants/string/networks/497f6eca-6276-4993-bfeb-53cbbbba6f08/entryPoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/emailSettings" \  -H "Content-Type: application/json" \  -d '{}'
{
  "replyMode": "DRAFT",
  "recipientFilter": [
    "string"
  ],
  "groupAddress": "string",
  "staffFromMailboxDomain": false,
  "staffAddresses": [
    "string"
  ],
  "signature": "string",
  "mailboxDailyRunLimit": 0,
  "version": 0,
  "activationState": "PENDING",
  "activatedAtMs": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}