curl --request PATCH \
--url https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cams_automation_enabled": true,
"cams_zip_password": "<string>",
"email": "<string>",
"kfin_zip_password": "<string>",
"reports_enabled": true
}
'import requests
url = "https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings"
payload = {
"cams_automation_enabled": True,
"cams_zip_password": "<string>",
"email": "<string>",
"kfin_zip_password": "<string>",
"reports_enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cams_automation_enabled: true,
cams_zip_password: '<string>',
email: '<string>',
kfin_zip_password: '<string>',
reports_enabled: true
})
};
fetch('https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'cams_automation_enabled' => true,
'cams_zip_password' => '<string>',
'email' => '<string>',
'kfin_zip_password' => '<string>',
'reports_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings"
payload := strings.NewReader("{\n \"cams_automation_enabled\": true,\n \"cams_zip_password\": \"<string>\",\n \"email\": \"<string>\",\n \"kfin_zip_password\": \"<string>\",\n \"reports_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cams_automation_enabled\": true,\n \"cams_zip_password\": \"<string>\",\n \"email\": \"<string>\",\n \"kfin_zip_password\": \"<string>\",\n \"reports_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cams_automation_enabled\": true,\n \"cams_zip_password\": \"<string>\",\n \"email\": \"<string>\",\n \"kfin_zip_password\": \"<string>\",\n \"reports_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"cams_automation_enabled": true,
"cams_zip_password_set": true,
"kfin_zip_password_set": true,
"reports_enabled": true,
"email": "<string>",
"inbound_address": "<string>"
}
}Update mailback settings
Partial update — an omitted field is unchanged, an empty email or password clears it. Passwords are write-only. Turning on cams_automation_enabled unlocks the schedule and request endpoints; it needs the email and CAMS password to be set before a report can actually be requested. An email already registered to another account is 409.
curl --request PATCH \
--url https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cams_automation_enabled": true,
"cams_zip_password": "<string>",
"email": "<string>",
"kfin_zip_password": "<string>",
"reports_enabled": true
}
'import requests
url = "https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings"
payload = {
"cams_automation_enabled": True,
"cams_zip_password": "<string>",
"email": "<string>",
"kfin_zip_password": "<string>",
"reports_enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cams_automation_enabled: true,
cams_zip_password: '<string>',
email: '<string>',
kfin_zip_password: '<string>',
reports_enabled: true
})
};
fetch('https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'cams_automation_enabled' => true,
'cams_zip_password' => '<string>',
'email' => '<string>',
'kfin_zip_password' => '<string>',
'reports_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings"
payload := strings.NewReader("{\n \"cams_automation_enabled\": true,\n \"cams_zip_password\": \"<string>\",\n \"email\": \"<string>\",\n \"kfin_zip_password\": \"<string>\",\n \"reports_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cams_automation_enabled\": true,\n \"cams_zip_password\": \"<string>\",\n \"email\": \"<string>\",\n \"kfin_zip_password\": \"<string>\",\n \"reports_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.mf-atlas.space/api/mailback-automation/v1/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cams_automation_enabled\": true,\n \"cams_zip_password\": \"<string>\",\n \"email\": \"<string>\",\n \"kfin_zip_password\": \"<string>\",\n \"reports_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"cams_automation_enabled": true,
"cams_zip_password_set": true,
"kfin_zip_password_set": true,
"reports_enabled": true,
"email": "<string>",
"inbound_address": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Settings to change
Whether the CAMS report automation (schedule and on-demand requests) is turned on. Needs the email and CAMS password above.
The password your CAMS reports are protected with (also used when the automation requests CAMS reports). Write-only. Empty clears it.
The registered email address CAMS and KFintech send your mailback reports to. Unique across accounts. Empty clears it.
The password your KFintech reports are protected with. Write-only. Empty clears it.
Whether the CAMS / KFintech report emails forwarded to the inbound address are ingested into holdings.