Domain: domain
Perbarui deskripsi domain
Menetapkan catatan Anda sendiri pada domain, misalnya kegunaannya. Hanya Anda yang dapat melihatnya.
https://g.sendcorex.com/v1/domaincommand: update_domain_descriptionMembutuhkan scope domain:create pada API key Anda.
Hingga 20 panggilan per menit per akun. Jika melebihi, perintah menjawab RATE_LIMITED.
Argumen
domainstringwajibNama domain.
mis.
"acme.com"descriptionstring | nullwajibHingga 255 karakter, tanpa HTML.
nullatau""mengosongkannya.mis.
"Transactional (app emails)"
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/domain',
{
commands: [
{
command: "update_domain_description",
args: {
domain: "acme.com",
description: "Transactional (app emails)"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Respons
{
"type": "SUCCESS",
"results": [
{
"command": "update_domain_description",
"id": "0",
"type": "SUCCESS",
"took_ms": 4,
"data": {
"domain": "acme.com",
"description": "Transactional (app emails)"
}
}
]
}Field respons
domainDomain-nya.
descriptionDeskripsi yang tersimpan, atau
null.
Error
Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.
- 401
INVALID_API_KEYAPI key tidak ada, sudah dicabut, atau dinonaktifkan di dashboard.
- 429
RATE_LIMITEDLebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik di Retry-After.
- CMD
MISSING_SCOPEAPI key tidak memiliki scope yang dibutuhkan perintah ini.
- CMD
INVALID_ARGSAda argumen yang tidak valid: `domain` tidak ada atau salah format, `key_size` selain 1024/2048, `email` tidak valid, deskripsi lebih dari 255 karakter…
- CMD
DOMAIN_NOT_FOUNDDomain tidak ada di akun Anda.
- CMD
RATE_LIMITEDPerintah ini dipanggil terlalu sering oleh akun Anda dalam satu menit terakhir. Tunggu satu menit.
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.