Getting Started
Tools
Inbox
Upsert Inbox
Create or update an inbox
POST
/
api
/
v1
/
inbox
/
upsert
curl --request POST \
--url https://app.botmailroom.com/api/v1/inbox/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email_address": "<string>",
"allow_cc": true,
"allow_bcc": true,
"spf_pass_required": true,
"dkim_pass_required": true,
"dmarc_pass_required": true,
"allowed_from_addresses": {
"addresses": [
"<string>"
],
"domains": [
"<string>"
]
},
"blocked_from_addresses": {
"addresses": [
"<string>"
],
"domains": [
"<string>"
]
},
"webhook_url": "<string>",
"webhook_authentication_type": "signing_secret",
"open_and_click_tracking": false,
"webhook_secret": "<string>"
}'
{
"id": "<string>",
"webhook_secret": "<string>",
"webhook_secret_preview": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
curl --request POST \
--url https://app.botmailroom.com/api/v1/inbox/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email_address": "<string>",
"allow_cc": true,
"allow_bcc": true,
"spf_pass_required": true,
"dkim_pass_required": true,
"dmarc_pass_required": true,
"allowed_from_addresses": {
"addresses": [
"<string>"
],
"domains": [
"<string>"
]
},
"blocked_from_addresses": {
"addresses": [
"<string>"
],
"domains": [
"<string>"
]
},
"webhook_url": "<string>",
"webhook_authentication_type": "signing_secret",
"open_and_click_tracking": false,
"webhook_secret": "<string>"
}'
{
"id": "<string>",
"webhook_secret": "<string>",
"webhook_secret_preview": "<string>"
}