Domain: domain

Perbarui deskripsi domain

Menetapkan catatan Anda sendiri pada domain, misalnya kegunaannya. Hanya Anda yang dapat melihatnya.

POSThttps://g.sendcorex.com/v1/domaincommand: update_domain_description
i

Membutuhkan scope domain:create pada API key Anda.

i

Hingga 20 panggilan per menit per akun. Jika melebihi, perintah menjawab RATE_LIMITED.

Argumen

  • domainstringwajib

    Nama domain.

    mis. "acme.com"

  • descriptionstring | nullwajib

    Hingga 255 karakter, tanpa HTML. null atau "" 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

  • domain

    Domain-nya.

  • description

    Deskripsi 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.

  • 401INVALID_API_KEY

    API key tidak ada, sudah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik di Retry-After.

  • CMDMISSING_SCOPE

    API key tidak memiliki scope yang dibutuhkan perintah ini.

  • CMDINVALID_ARGS

    Ada argumen yang tidak valid: `domain` tidak ada atau salah format, `key_size` selain 1024/2048, `email` tidak valid, deskripsi lebih dari 255 karakter…

  • CMDDOMAIN_NOT_FOUND

    Domain tidak ada di akun Anda.

  • CMDRATE_LIMITED

    Perintah ini dipanggil terlalu sering oleh akun Anda dalam satu menit terakhir. Tunggu satu menit.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.