ReceivingInboxResponse

successboolean

Example: true

data object

environmentstring

Current NODE_ENV environment

Possible values: [development, test, production]

receivingInboxes object[]

Array [

idstring<uuid>

Receiving inbox ID

customer_idinteger

Customer ID

default_receiving_inboxboolean

Is this the default receiving inbox

activeboolean

Is inbox active

current_receiving_inboxstring

Email address for current environment (based on NODE_ENV)

dev_receiving_inboxstring

Development environment email address

test_receiving_inboxstring

Test environment email address

prod_receiving_inboxstring

Production environment email address

]

countinteger

Number of receiving inboxes returned

ReceivingInboxResponse

{
  "success": true,
  "data": {
    "environment": "development",
    "receivingInboxes": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customer_id": 0,
        "default_receiving_inbox": true,
        "active": true,
        "current_receiving_inbox": "string",
        "dev_receiving_inbox": "string",
        "test_receiving_inbox": "string",
        "prod_receiving_inbox": "string"
      }
    ],
    "count": 0
  }
}