Skip to content
ReputeCastReputeCast Docs

Set up and test the SMTP bounce mailbox

POST
/api/v1/workspaces/{workspace}/connect/setups/{setupId}/mailbox
curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/connect/setups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mailbox \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "address": "example", "afterProcessing": "move", "folder": "example", "host": "example", "password": "example", "pollEvery": "1m", "port": 1, "protocol": "imap", "tls": "tls", "username": "example" }'

Permission: providers:manage (sensitive)

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

setupId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
address
required

The return-path address bounces go to

string
<= 254 characters
afterProcessing
string
Allowed values: move delete leave
folder
string
<= 200 characters
host
required
string
>= 1 characters <= 253 characters
password
string
<= 1024 characters
pollEvery
string
Allowed values: 1m 5m 15m
port
required
integer format: int64
>= 1 <= 65535
protocol
required
string
Allowed values: imap pop3
tls
required
string
Allowed values: tls starttls none
username
required
string
<= 254 characters

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
adapter
required
string
canManage
required
boolean
connection
required
object
access
required
string
Allowed values: role keys
account
required
string
accountId
required
string
at
string format: date-time
canContinue
required
boolean
error
object
code
string
detail
string
field
string
message
required
string
externalId
required
string
fields
required
Array<object>
object
help
string
key
required
string
label
required
string
options
required
Array<object>
object
label
required
string
value
required
string
required
required
boolean
secret
required
boolean
set
required
boolean
type
required
string
Allowed values: text number
value
required
string
mailbox
object
at
required
string format: date-time
error
string
ok
required
boolean
summary
required
string
transcript
required
string
provisionDone
required
integer format: int64
provisionTotal
required
integer format: int64
provisioning
required
Array<object>
object
at
string format: date-time
error
string
hint
string
key
required
string
status
required
string
Allowed values: waiting running done failed
text
required
string
region
required
string
regions
required
Array<object>
object
err
string
label
required
string
max24h
required
integer format: int64
maxRate
required
number format: double
name
required
string
production
required
boolean
region
required
string
roleArn
required
string
sandbox
object
dailyVolume
required
integer format: int64
language
required
string
Allowed values: en ja
mailType
required
string
Allowed values: marketing transactional
name
required
string
region
required
string
requestedAt
string format: date-time
selected
required
boolean
useCase
required
string
website
required
string
smtp
object
at
required
string format: date-time
error
string
ok
required
boolean
summary
required
string
transcript
required
string
smtpForm
object
afterProcessing
required
string
Allowed values: move delete leave
dailyCap
required
string
folder
required
string
host
required
string
mailboxHost
required
string
mailboxPasswordSet
required
boolean
mailboxPort
required
integer format: int64
mailboxTls
required
string
Allowed values: tls starttls none
mailboxUser
required
string
maxRate
required
string
passwordSet
required
boolean
pollEvery
required
string
Allowed values: 1m 5m 15m
port
required
integer format: int64
protocol
required
string
Allowed values: imap pop3
returnPath
required
string
tls
required
string
Allowed values: starttls tls none
username
required
string
status
required
string
Allowed values: none connected failed
summary
required
string
template
object
launchUrl
required
string
policy
required
string
principal
required
string
roleName
required
string
webhook
object
mode
required
string
Allowed values: webhook polling mailbox none
needsSecret
required
boolean
publicUrl
required
string
registration
object
at
required
string format: date-time
detail
string
status
required
string
Allowed values: done skipped failed manual
secretHeader
string
selfTest
object
at
required
string format: date-time
code
string
ok
required
boolean
private
required
boolean
reason
string
url
required
string
working
required
boolean
createdAt
required
string format: date-time
domain
required
object
domainId
required
string
name
required
string
skipped
required
boolean
suggested
required
string
done
object
domain
required
string
hostRepute
required
boolean
minutes
required
integer format: int64
rows
required
Array<object>
object
importLink
required
boolean
lead
required
string
status
required
string
Allowed values: done skipped failed pending
text
required
string
title
required
string
finishedAt
string format: date-time
helpers
required
Array<string>
id
required
string
info
required
object
adapter
required
string
bulkAllowed
required
boolean
canPoll
required
boolean
canRegister
required
boolean
connectionHint
required
string
domainHint
required
string
fields
required
Array<object>
object
help
string
key
required
string
label
required
string
options
required
Array<object>
object
label
required
string
value
required
string
required
required
boolean
secret
required
boolean
set
required
boolean
type
required
string
Allowed values: text number
value
required
string
flow
required
string
Allowed values: ses smtp api
heading
required
string
keyHint
required
string
keysUrl
required
string
lead
required
string
name
required
string
section
required
string
short
required
string
step1
required
string
title
required
string
verifyCall
required
string
webhookEvents
required
string
webhooks
required
string
provider
required
string
providerId
required
string
status
required
string
Allowed values: open finished abandoned
step
required
string
Allowed values: connection domain test streams contacts done
streams
required
object
defaults
required
string
saved
required
boolean
streams
required
Array<object>
object
allowed
required
boolean
configurationSet
required
string
current
required
Array<string>
description
required
string
enabled
required
boolean
failover
required
string
hasRoute
required
boolean
name
required
string
reason
string
role
required
string
Allowed values: primary split fallback
roleLabel
required
string
stream
required
string
Allowed values: broadcast automation system transactional
tracking
required
string
weight
required
integer format: int64
tips
required
Array<string>
summaries
required
object
connection
required
string
domain
required
string
domainShort
required
string
provider
required
string
streams
required
string
test
required
string
updatedAt
required
string format: date-time

Example 

{
  "connection": {
    "access": "role",
    "fields": [
      {
        "type": "text"
      }
    ],
    "provisioning": [
      {
        "status": "waiting"
      }
    ],
    "sandbox": {
      "language": "en",
      "mailType": "marketing"
    },
    "smtpForm": {
      "afterProcessing": "move",
      "mailboxTls": "tls",
      "pollEvery": "1m",
      "protocol": "imap",
      "tls": "starttls"
    },
    "status": "none",
    "webhook": {
      "mode": "webhook",
      "registration": {
        "status": "done"
      }
    }
  },
  "done": {
    "rows": [
      {
        "status": "done"
      }
    ]
  },
  "info": {
    "fields": [
      {
        "type": "text"
      }
    ],
    "flow": "ses"
  },
  "status": "open",
  "step": "connection",
  "streams": {
    "streams": [
      {
        "role": "primary",
        "stream": "broadcast"
      }
    ]
  }
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0