Update a domain's custom args

PUT 
/v1/domain/custom-args/:domain

Replaces the custom args of an existing domain with the supplied object

Request

Path Parameters

domain stringrequired

Domain Name

application/json

Body

required

Custom Args Payload

custom_args

object

property name* any

Responses

200

Domain custom args updated successfully

application/json

Schema

Schema

email_domain

object

account_id integer

active boolean

created_at string

custom_args

object

property name* any

domain string

id integer

is_tenant_domain boolean

mailer_id string

mailer_service_id integer

root_domain_id integer

sending_verified boolean

tenant_id integer

type string

updated_at string
message string
success boolean

Example (from schema)

{
  "email_domain": {
    "account_id": 0,
    "active": true,
    "created_at": "string",
    "custom_args": {},
    "domain": "string",
    "id": 0,
    "is_tenant_domain": true,
    "mailer_id": "string",
    "mailer_service_id": 0,
    "root_domain_id": 0,
    "sending_verified": true,
    "tenant_id": 0,
    "type": "string",
    "updated_at": "string"
  },
  "message": "Domain custom args updated successfully",
  "success": true
}

400

error: Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

404

error: Not Found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

Loading...