Skip to content
DocsToSheets

Update mailbox config

PUT
/api/Mailboxes/{id}/config
 
curl --request PUT \
  --url https://app.docstosheets.com/api/Mailboxes/example/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "hint": "example", "fields": [ { "key": "example", "label": "example", "type": "text", "hint": "example", "unit": "example", "values": [ "example" ], "required": true, "formula": "example", "validator": { "kind": "email", "pattern": "example", "expression": "example", "message": "example" }, "validate": "example" } ], "groups": [ { "id": "example", "name": "example", "fields": [ { "key": "example", "label": "example", "type": "text", "hint": "example", "unit": "example", "values": [ "example" ], "required": true, "formula": "example", "validator": { "kind": "email", "pattern": "example", "expression": "example", "message": "example" }, "validate": "example" } ] } ], "splitKeys": [ { "fieldKey": "example", "interval": "year" } ], "layout": { "label": "example", "children": [ { "type": "grid", "span": 1, "children": [], "level": 1, "key": "example", "label": "example", "control": "text", "group": "example", "tableColumns": [ "example" ] } ] } }'

Replaces the mailbox’s extraction config (fields and repeating groups).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
string
nullable
hint
string
nullable
fields
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
boolean
formula
string
nullable
validator
One of:
object
kind
required
string
Allowed values: email usZip regex formula
pattern
string
nullable
expression
string
nullable
message
string
nullable
validate
string
nullable
groups
Array<object>
object
id
required
string
name
required
string
fields
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
boolean
formula
string
nullable
validator
One of:
object
kind
required
string
Allowed values: email usZip regex formula
pattern
string
nullable
expression
string
nullable
message
string
nullable
validate
string
nullable
splitKeys
Array<object>
object
fieldKey
required
string
interval
One of:

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

string
Allowed values: year month day
layout
One of:
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
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

Responses

Section titled “ Responses ”

200

Section titled “200 ”
Media type application/json
object
id
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
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
id
required
string
name
required
string
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
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:

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

string
Allowed values: year month day
layout
One of:
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
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:

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:

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
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

Section titled “400 ”
Media type 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

Section titled “404 ”
Media type 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

Section titled “409 ”
Media type 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"
}