Skip to main content

Update Mailing Settings

Update the mailing settings for your account. Only the fields you include are changed.

The response is the full settings object, the same object Get Mailing Settings returns.

Request​

PATCH /settings

Request Body​

All fields are optional. Only fields included in the body are changed; omit a field to leave it unchanged. An empty object changes nothing and returns the current settings.

ParameterTypeRequiredDescription
namestring|nullNoFooter name (max 255 characters). Send null or "" to clear.
addressstring|nullNoFooter address (max 255 characters). Send null or "" to clear.
timezone_uuidstring|nullNoUUID of a timezone from List Timezones. An unknown UUID returns 404. Send null to clear the workspace timezone.
requires_double_opt_inbooleanNoWhether a hosted list signup requires confirmation. Send true or false. null is rejected with 422. See Double opt-in.

Example Request​

curl -X PATCH "https://email.easy.tools/api/v1/settings" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "timezone_uuid": "3e91c6b5-27af-4d0c-9b84-6f1a05d3e7c2"
  }'

Example Request — clear the workspace timezone​

curl -X PATCH "https://email.easy.tools/api/v1/settings" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "timezone_uuid": null
  }'

Response​

Success Response (200 OK)​

{
  "data": {
    "name": "Acme",
    "address": "1 Example Street, New York, NY 10001",
    "timezone": {
      "uuid": "3e91c6b5-27af-4d0c-9b84-6f1a05d3e7c2",
      "iana": "America/New_York",
      "region": "America",
      "city": "New York"
    },
    "requires_double_opt_in": false
  }
}

Response Fields​

The settings object has the fields described in Mailing Settings Object.

Error Responses​

Not Found Error (404 — Timezone)​

Returned when timezone_uuid does not match a timezone from List Timezones. Settings are not changed.

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Timezone not found"
  }
}

Validation Error (422 Unprocessable Entity)​

Returned when the body is malformed. timezone_uuid must be a UUID, name and address must be at most 255 characters, and requires_double_opt_in must be true or false.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The given data was invalid",
    "details": {
      "requires_double_opt_in": ["The requires double opt in field must be true or false."]
    }
  }
}