GET
/v1/workspace/automated-emailsRead the workspace's automated emails
Which system mails this service still sends about the workspace's deals — facility status, the four submission notices, SBA readiness and the merchant decline notice — with each one's subject prefix and introduction, plus the sender name and reply-to they go out under. Every kind is always present, so this is the list of what a workspace can switch off as well as what it has. Never 404s: an untouched workspace reads the defaults, which are all on.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Responses
200application/json
the action's answer
{
"data": {
"emails": {
"facility_status": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
},
"merchant_decline": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
},
"submission_contracts": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
},
"submission_decision": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
},
"submission_funding": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
},
"submission_missing_info": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
},
"term_loan_readiness": {
"enabled": true,
"introduction": "string",
"subject_prefix": "string"
}
},
"sender": {
"name": "string",
"reply_to": "string"
}
}
}datarequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired