---
title: "Update the business SES transport settings"
description: "Omit secretAccessKey to keep the stored one; send an empty string to clear it."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/webhooks/update-the-business-ses-transport-settings"
---
# Update the business SES transport settings

> Omit secretAccessKey to keep the stored one; send an empty string to clear it.

<api-operation method="PATCH" path="/v1/businesses/{biz}/emails/ses">
<template v-slot:docs="">

Omit `secretAccessKey` to keep the stored one; send an empty string to clear it. ⚠ This body is camelCase — `accessKeyId`, `secretAccessKey`, `configurationSet` — unlike the snake_case used elsewhere in this API. Documented as the route actually parses it (`sesSettingsSchema`) rather than normalised to look consistent, because a client following a tidied-up spec would send fields the route ignores.

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
</tbody>
</table>

## Headers

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        Idempotency-Key
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Safely retry writes — repeats return the original response. If a write FAILED after it had already taken effect, that failure is what repeats: the key is spent, and a new attempt needs a new key.
    </td>
  </tr>
</tbody>
</table>

## Body

The request body is **required**.

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        enabled
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Whether the business sends email through its own Amazon SES account.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        region
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      The AWS region used to send email.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        accessKeyId
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      The AWS access key id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        configurationSet
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      The SES configuration set to attach to each send.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        secretAccessKey
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Absent keeps the stored key, '' clears it, a value replaces it.
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        ses_settings
      </code>
      
      . One of <code>
        ses_settings
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        enabled
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      When false, this business sends through the deployment-wide MAILER_PROVIDER.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        region
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The AWS region used to send email.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        access_key_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Identifies the credential; safe to render. The secret half is never returned.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        configuration_set
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The SES configuration set attached to each send.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        secret_configured
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      Whether a secret access key is stored. Never the key itself.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        effective_transport
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      What this business actually sends through, once SMTP/SES/platform is resolved.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        delivers
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      Whether that transport can deliver — a configured transport is not necessarily a working one.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        effective_from_address
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The From address used for sends.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        effective_from_name
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The From name used for sends.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        from_source
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Where the From address comes from: this business or the platform. One of <code>
        business
      </code>
      
      , <code>
        platform
      </code>
      
      .
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Updated
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        400
      </code>
    </td>
    
    <td>
      Invalid SES settings
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        404
      </code>
    </td>
    
    <td>
      No such business
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        409
      </code>
    </td>
    
    <td>
      Idempotency-Key conflict — the key is already in flight, or was reused with a different request payload.
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl -X PATCH "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/emails/ses" \
  -H "Authorization: Bearer $TMBILLING_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false,
    "region": "us-east-1"
  }'
```

</template>

<template v-slot:response="">
<code-group>

```json [200 OK]
{
  "object": "ses_settings",
  "enabled": false,
  "region": "us-east-1",
  "access_key_id": "AKIAXXXXXXXXXXXXXXXX",
  "configuration_set": "billing-mail",
  "secret_configured": false,
  "effective_transport": "ses",
  "delivers": false,
  "effective_from_address": "billing@example.com",
  "effective_from_name": "Brightwater Analytics",
  "from_source": "business"
}
```

```json [400 Bad Request]
{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid SES settings"
  }
}
```

```json [404 Not Found]
{
  "error": {
    "type": "invalid_request_error",
    "message": "No such business"
  }
}
```

```json [409 Conflict]
{
  "error": {
    "type": "idempotency_error",
    "message": "Idempotency-Key conflict — the key is already in flight, or was reused with a different request payload."
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.