Credentials (API) | Inbox Manager API ドキュメント

Provider credential endpoints

GET/api/accounts/{account_id}/credentials

List provider credentials available in the current account scope. More | Credentials

Responses

200application/json

schemaobject

dataarrayrequired

itemProviderCredentialrequired

A provider credential used to access IMAP/SMTP providers for mailbox sync and outbound delivery.

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/credentials?limit=20&offset=0");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/credentials

Create and store one credential row for mailbox sync and outbound send. Standard domains use IMAP/SMTP settings, while inferred OAuth providers (Gmail, Outlook, Apple) validate via provider APIs and reject explicit IMAP/SMTP overrides. More | Credentials

Body application/json

labelstring | null

imapobject

hoststringrequired

portintegerrequired

security_moderequired

smtpobject

hoststringrequired

portintegerrequired

security_moderequired

secretobjectrequired

emailstring · emailrequired

usernamestring | nullrequired

passwordstring | nullrequired

oauth_grant_idstring | nullrequired

OAuth credential grant identifier.

Responses

201application/json

Created

schemaobject

dataProviderCredentialrequired

A provider credential used to access IMAP/SMTP providers for mailbox sync and outbound delivery.

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/credentials" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}'

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const url = "${BASE_URL}/api/accounts/acc123/credentials";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const url = "${BASE_URL}/api/accounts/acc123/credentials";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/credentials",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/credentials",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const { body } = await request("${BASE_URL}/api/accounts/acc123/credentials", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/credentials", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/credentials", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/credentials", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
uri = URI("${BASE_URL}/api/accounts/acc123/credentials")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/credentials", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/credentials");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"label\":\"value\",\"imap\":{\"host\":\"string\",\"port\":123,\"security_mode\":\"ssl_tls\"},\"smtp\":{\"host\":\"string\",\"port\":123,\"security_mode\":\"ssl_tls\"},\"secret\":{\"email\":\"string\",\"username\":\"value\",\"password\":\"value\",\"oauth_grant_id\":\"value\"}}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/credentials/oauth/{provider}/finalize

Auto-generated OpenAPI docs for undocumented route.

Responses

200application/json

schemaobject

dataobjectrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/finalize");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/credentials/oauth/{provider}/revoke

Auto-generated OpenAPI docs for undocumented route.

Responses

200application/json

schemaobject

dataobjectrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/revoke");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/credentials/oauth/{provider}/start

Auto-generated OpenAPI docs for undocumented route.

Responses

200application/json

schemaobject

dataobjectrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/{account_id}/credentials/oauth/{provider}/start");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/credentials/search

Search provider credentials by label, IMAP host, SMTP host, or masked username. More | Credentials

Body application/json

querystringrequired

limitinteger

offsetinteger

Responses

200application/json

schemaobject

dataarrayrequired

itemProviderCredentialrequired

A provider credential used to access IMAP/SMTP providers for mailbox sync and outbound delivery.

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/credentials/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123}'

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/credentials/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/credentials/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/credentials/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/credentials/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/credentials/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/credentials/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/credentials/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/credentials/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123}
uri = URI("${BASE_URL}/api/accounts/acc123/credentials/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/credentials/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/credentials/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/credentials/test

Validate credential input before persisting. Standard domains validate protocol connectivity and autodetect missing IMAP/SMTP settings; inferred OAuth providers (Gmail, Outlook, Apple) validate provider API access and use provider defaults. More | Credentials

Body application/json

labelstring | null

imapobject

hoststringrequired

portintegerrequired

security_moderequired

smtpobject

hoststringrequired

portintegerrequired

security_moderequired

secretobjectrequired

emailstring · emailrequired

usernamestring | nullrequired

passwordstring | nullrequired

oauth_grant_idstring | nullrequired

OAuth credential grant identifier.

Responses

200application/json

schemaobject

dataobjectrequired

statusrequired

error_codestring | nullrequired

detailstring | nullrequired

credentialobject

labelstring | nullrequired

imapobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

smtpobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

auth_kindrequired

secretobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/credentials/test" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}'

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const url = "${BASE_URL}/api/accounts/acc123/credentials/test";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const url = "${BASE_URL}/api/accounts/acc123/credentials/test";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/credentials/test",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/credentials/test",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const { body } = await request("${BASE_URL}/api/accounts/acc123/credentials/test", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/credentials/test", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/credentials/test", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/credentials/test", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
uri = URI("${BASE_URL}/api/accounts/acc123/credentials/test")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"label":"value","imap":{"host":"string","port":123,"security_mode":"ssl_tls"},"smtp":{"host":"string","port":123,"security_mode":"ssl_tls"},"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/credentials/test", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/credentials/test");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"label\":\"value\",\"imap\":{\"host\":\"string\",\"port\":123,\"security_mode\":\"ssl_tls\"},\"smtp\":{\"host\":\"string\",\"port\":123,\"security_mode\":\"ssl_tls\"},\"secret\":{\"email\":\"string\",\"username\":\"value\",\"password\":\"value\",\"oauth_grant_id\":\"value\"}}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/credentials/{provider_credential_id}

Soft-delete a provider credential so it is no longer used by tasks/jobs. More | Credentials

Responses

204

No Content

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/credentials/icr123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/credentials/icr123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/credentials/icr123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/credentials/icr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/credentials/icr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/credentials/icr123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/credentials/icr123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/credentials/icr123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/credentials/icr123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/credentials/icr123")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/credentials/icr123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/credentials/icr123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/credentials/{provider_credential_id}

Get one provider credential by ID. More | Credentials

Responses

200application/json

schemaobject

dataProviderCredentialrequired

A provider credential used to access IMAP/SMTP providers for mailbox sync and outbound delivery.

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/credentials/icr123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/credentials/icr123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/credentials/icr123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/credentials/icr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/credentials/icr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/credentials/icr123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/credentials/icr123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/credentials/icr123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/credentials/icr123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/credentials/icr123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/credentials/icr123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/credentials/icr123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/credentials/{provider_credential_id}

Update provider credential metadata and protocol connection settings. OAuth-inferred providers reject explicit IMAP/SMTP overrides. More | Credentials

Body application/json

labelstring | null

imapobject | null

hoststringrequired

portintegerrequired

security_moderequired

smtpobject | null

hoststringrequired

portintegerrequired

security_moderequired

Responses

200application/json

schemaobject

dataProviderCredentialrequired

A provider credential used to access IMAP/SMTP providers for mailbox sync and outbound delivery.

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/credentials/icr123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"label":"value","imap":"value","smtp":"value"}'

const payload = {"label":"value","imap":"value","smtp":"value"};
const url = "${BASE_URL}/api/credentials/icr123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"label":"value","imap":"value","smtp":"value"};
const url = "${BASE_URL}/api/credentials/icr123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"label":"value","imap":"value","smtp":"value"};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/credentials/icr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"label":"value","imap":"value","smtp":"value"};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/credentials/icr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"label":"value","imap":"value","smtp":"value"};
const { body } = await request("${BASE_URL}/api/credentials/icr123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"label":"value","imap":"value","smtp":"value"}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/credentials/icr123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"label":"value","imap":"value","smtp":"value"}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/credentials/icr123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"label":"value","imap":"value","smtp":"value"}`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/credentials/icr123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"label":"value","imap":"value","smtp":"value"}
uri = URI("${BASE_URL}/api/credentials/icr123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"label":"value","imap":"value","smtp":"value"};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/credentials/icr123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/credentials/icr123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"label\":\"value\",\"imap\":\"value\",\"smtp\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/credentials/{provider_credential_id}/rotate

Rotate encrypted secret material while preserving credential identity. More | Credentials

Body application/json

secretobjectrequired

emailstring · emailrequired

usernamestring | nullrequired

passwordstring | nullrequired

oauth_grant_idstring | nullrequired

OAuth credential grant identifier.

Responses

200application/json

schemaobject

dataobjectrequired

credentialProviderCredentialrequired

A provider credential used to access IMAP/SMTP providers for mailbox sync and outbound delivery.

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/credentials/icr123/rotate" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}'

const payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const url = "${BASE_URL}/api/credentials/icr123/rotate";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const url = "${BASE_URL}/api/credentials/icr123/rotate";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/credentials/icr123/rotate",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/credentials/icr123/rotate",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
const { body } = await request("${BASE_URL}/api/credentials/icr123/rotate", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/credentials/icr123/rotate", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/credentials/icr123/rotate", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/credentials/icr123/rotate", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}}
uri = URI("${BASE_URL}/api/credentials/icr123/rotate")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"secret":{"email":"string","username":"value","password":"value","oauth_grant_id":"value"}};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/credentials/icr123/rotate", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/credentials/icr123/rotate");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"secret\":{\"email\":\"string\",\"username\":\"value\",\"password\":\"value\",\"oauth_grant_id\":\"value\"}}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

ProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

ProviderCredential

idstringrequired

Provider credential identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

labelstring | nullrequired

imap_hoststringrequired

imap_portintegerrequired

imap_security_moderequired

smtp_hoststringrequired

smtp_portintegerrequired

smtp_security_moderequired

emailstring · emailrequired

usernamestring | nullrequired

provider_idrequired

auth_kindrequired

username_maskedstringrequired

last_validated_atstring | nullrequired

last_validation_statusstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Credentials

Contents

List provider credentials

Create paired provider credential

POST /api/accounts/:account_id/credentials/oauth/:provider/finalize

POST /api/accounts/:account_id/credentials/oauth/:provider/revoke

POST /api/accounts/:account_id/credentials/oauth/:provider/start

Search provider credentials

Test provider credential input

Delete provider credential

Get provider credential

Patch provider credential

Rotate provider credential secret

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types