PUT
/v1/workspace/automated-emailsReplace the workspace's automated emails
Turn the workspace's system mails on or off and set the name and reply-to they go out under. Admin only, and it replaces the whole document rather than patching — send what the read answered with the changes merged in, or the mails you left out are the ones you turned off. A kind outside the vocabulary, an over-long subject prefix, or a reply-to that is not an email address is refused with the field named.
Access class: workspace:admin.
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.
Request body
application/jsonrequiredbodyoptional
paramsobjectoptional
queryobjectoptional
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