Update a mailbox

PUT

/api/Mailboxes/{id}

const url = 'https://app.docstosheets.com/api/Mailboxes/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","isActive":true,"notificationPreferences":{"documentProcessed":{"email":true,"push":true},"documentFailed":{"email":true,"push":true},"mailboxShared":{"email":true,"push":true}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://app.docstosheets.com/api/Mailboxes/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "isActive": true, "notificationPreferences": { "documentProcessed": { "email": true, "push": true }, "documentFailed": { "email": true, "push": true }, "mailboxShared": { "email": true, "push": true } } }'

Updates the mailbox’s name, active state, and notification preferences. Owner only.

Authorizations

oauth2
api.read api.write

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

name

required

string

isActive

required

boolean

notificationPreferences

One of:

object

Controls which automated notifications are sent for this mailbox and over which channels (email and/or native device push).

object

documentProcessed

One of:

object

Delivery channels for a single notification type. Both channels default to enabled; push delivery additionally requires a registered device installation.

object

email

boolean

push

boolean

documentFailed

One of:

object

Delivery channels for a single notification type. Both channels default to enabled; push delivery additionally requires a registered device installation.

object

email

boolean

push

boolean

mailboxShared

One of:

object

Delivery channels for a single notification type. Both channels default to enabled; push delivery additionally requires a registered device installation.

object

email

boolean

push

boolean

Example ^generated

{
  "name": "example",
  "isActive": true,
  "notificationPreferences": {
    "documentProcessed": {
      "email": true,
      "push": true
    },
    "documentFailed": {
      "email": true,
      "push": true
    },
    "mailboxShared": {
      "email": true,
      "push": true
    }
  }
}

Responses

200

application/json

object

required

string

name

required

string

emailAddress

required

string

config

required

object

name

string

nullable

hint

string

nullable

fields

required

Array<object>

object

key

required

string

label

string

nullable

type

required

Canonical field type vocabulary, serialized lowercase (text, number, integer, currency, date, time, datetime, boolean, enum, address) — identical tokens in C#, TypeScript, the renderer, and the extraction prompt. Integer/Time/Datetime/Enum semantics (normalization, prompts, controls) land in a later phase.

string

Allowed values: text number integer currency date time datetime boolean enum address

hint

string

nullable

unit

string

nullable

values

Array<string>

nullable

required

required

boolean

formula

string

nullable

validator

One of:

object

object

kind

required

string

Allowed values: email usZip regex formula

pattern

string

nullable

expression

string

nullable

message

string

nullable

validate

string

nullable

groups

required

Array<object>

object

required

string

name

required

string

fields

required

Array<object>

object

key

required

string

label

string

nullable

type

required

string

Allowed values: text number integer currency date time datetime boolean enum address

hint

string

nullable

unit

string

nullable

values

Array<string>

nullable

required

required

boolean

formula

string

nullable

validator

One of:

object

object

kind

required

string

Allowed values: email usZip regex formula

pattern

string

nullable

expression

string

nullable

message

string

nullable

validate

string

nullable

splitKeys

required

Array<object>

object

fieldKey

required

string

interval

One of:

string

Granularity used to bucket date/datetime split-key values.

string

Allowed values: year month day

layout

One of:

object

object

version

required

integer format: int32

definition

required

object

label

string

nullable

children

required

Array<object>

object

type

required

string

Allowed values: grid card heading field table

span

integer format: int32

nullable

children

Array<object> recursive

level

integer format: int32

nullable

key

string

nullable

label

string

nullable

control

One of:

string

string

Allowed values: text textarea number date time datetime checkbox currency select

group

For Table nodes: the repeating section (group id) this table renders. May be omitted when the config has exactly one section.

string

nullable

tableColumns

Array<string>

nullable

source

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

isActive

required

boolean

hasDocuments

required

boolean

configLocked

required

boolean

totalDocuments

required

integer format: int32

accessType

required

string

Allowed values: owned shared

ownerEmail

string

nullable

exportProvider

required

One of:

string

The export provider for a mailbox’s extracted data.

string

Allowed values: none googleDrive oneDrive

exportFolderUrl

URL to the export folder in the provider (Google Drive or OneDrive).

string

nullable

exportSpreadsheetUrl

URL to the export spreadsheet (Google Sheets or Excel Online). Only set for mailboxes without split keys; split mailboxes expose per-split workbook URLs via the splits endpoint.

string

nullable

syncStatus

required

One of:

string

State of the mailbox’s workbook synchronization (full-rewrite export).

string

Allowed values: idle syncing failed

lastSyncedAt

When the workbook was last fully rewritten by sync.

string format: date-time

nullable

syncLastError

Last sync failure message (null when the last sync succeeded).

string

nullable

sampleInferenceSessionId

The mailbox-config draft session this mailbox was created from, if any. Its sample documents feed the layout agent (“Adjust with AI”) and future re-inference.

string

nullable

notificationPreferences

required

One of:

object

object

documentProcessed

required

object

email

required

boolean

push

required

boolean

documentFailed

required

object

email

required

boolean

push

required

boolean

mailboxShared

required

object

email

required

boolean

push

required

boolean

createdAt

required

string format: date-time

Example

{
  "config": {
    "fields": [
      {
        "type": "text",
        "validator": {
          "kind": "email"
        }
      }
    ],
    "groups": [
      {
        "fields": [
          {
            "type": "text",
            "validator": {
              "kind": "email"
            }
          }
        ]
      }
    ],
    "splitKeys": [
      {
        "interval": "year"
      }
    ],
    "layout": {
      "definition": {
        "children": [
          {
            "type": "grid",
            "control": "text"
          }
        ]
      }
    }
  },
  "accessType": "owned",
  "exportProvider": "none",
  "syncStatus": "idle"
}

400

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Update a mailbox

Authorizations

Parameters

Path Parameters

Request Body required

Example generated

Responses

200

Example

400

Example generated

404

Example generated

409

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated