मेलबॉक्स सेटिंग्स

API 0.16.0OpenAPIllms-full.txt

PATCH/v1/mailboxes/{mailbox_id}

/v1 से name, password और signature बदलें। साझा quota_mb को होस्टिंग पैनल से बदलें। फ़ाइलों का अलग कोटा नहीं है। Idempotency-Key वैकल्पिक है, लेकिन दोबारा अनुरोध करने पर इसे उपयोग करना बेहतर है।

प्राधिकरण और पहुंच क्षेत्र · त्रुटियाँ और दोहराव

अनुरोध

curl -X PATCH 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"name":"Support","signature":"Support team"}'

विकल्प

mailbox_idpathअनिवार्य रूप से

integer

X-Customer-IDheader

विकल्प 1

string

विकल्प 2

null

Idempotency-Keyheader

string

minLength: 8

maxLength: 128

निकाय से अनुरोध करें · application/json

object

name

विकल्प 1

string

minLength: 1

maxLength: 120

विकल्प 2

null

quota_mb

विकल्प 1

integer

minimum: 10240

विकल्प 2

null

file_quota_mb

विकल्प 1

integer

minimum: 256

maximum: 512000

विकल्प 2

null

password

विकल्प 1

string

minLength: 12

maxLength: 128

विकल्प 2

null

signature

विकल्प 1

string

maxLength: 5000

विकल्प 2

null

अज्ञात फ़ील्ड स्वीकार नहीं किए जाते.

प्रतिक्रियाएँ

202 सफल प्रतिक्रिया

application/json

object

id

string · uuid

स्थिति की जांच करने और लंबित सबमिशन को रद्द करने के लिए ऑपरेशन आईडी।

kind

string

mailbox_id

विकल्प 1

integer

विकल्प 2

null

status

string

मान्य मान: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है

created_at

string

UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है

completed_at

विकल्प 1

string

UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है

विकल्प 2

null

error

यदि ऑपरेशन सफलतापूर्वक पूरा नहीं हुआ तो त्रुटि का कारण।

विकल्प 1

string

विकल्प 2

null

result

ऑपरेशन का नतीजा. भेजने के लिए, स्वीकृत और अस्वीकृत प्राप्तकर्ताओं के बारे में जानकारी शामिल है।

विकल्प 1

object

विकल्प 2

null

400 अमान्य शीर्षलेख या पहचानकर्ता

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

401 लॉगिन आवश्यक है

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

403 तक पहुँच नहीं

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

404 संसाधन नहीं मिला

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

409 राज्य संघर्ष

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

422 सत्यापन त्रुटि

application/json

object

detail

array

सरणी तत्व

object

locअनिवार्य रूप से

array

सरणी तत्व

विकल्प 1

string

विकल्प 2

integer

msgअनिवार्य रूप से

string

typeअनिवार्य रूप से

string

503 अस्थायी अनुपलब्धता

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object