Skip to main content
PATCH
/
inbound
/
settings
/
{uuid}
curl --request PATCH \
  --url https://api.jetemail.com/inbound/settings/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "disabled"
}
'
{
  "success": true,
  "message": "Domain updated successfully"
}

Authorizations

​
Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Path Parameters

​
uuid
string<uuid>
required

UUID of the inbound domain

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

Any subset of the listed fields. At least one updatable field is required; sending an empty body returns 400.

​
status
enum<string>

Domain status. "disabled" causes inbound-edge to stop accepting mail for the domain.

Available options:
active,
disabled
​
delivery_type
enum<string>

Switch the domain's delivery mode. The body may also include the new mode's fields in the same request.

Available options:
smtp,
webhook,
forward
​
smtp_servers
(string | object)[]

Only for delivery_type=smtp. Rejected with 400 if sent on a webhook or forward domain.

Example:

"mail.example.com:25"

​
webhook_url
string<uri> | null

Only for delivery_type=webhook. Rejected with 400 if sent on an smtp or forward domain. Pass null to clear.

Example:

"https://example.com/webhook/inbound"

​
webhook_method
enum<string>

Only for delivery_type=webhook. Rejected with 400 if sent on an smtp or forward domain.

Available options:
POST,
PUT
​
webhook_headers
object

Only for delivery_type=webhook. Rejected with 400 if sent on an smtp or forward domain. Pass null to clear.

​
webhook_timeout
integer | null

Only for delivery_type=webhook. Rejected with 400 if sent on an smtp or forward domain.

​
webhook_retry_count
integer | null

Only for delivery_type=webhook. Rejected with 400 if sent on an smtp or forward domain.

​
webhook_auth_header
string | null

Only for delivery_type=webhook. Rejected with 400 if sent on an smtp or forward domain.

Response

Settings updated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Domain updated successfully"