Sign in
Email Providers

Update an email provider

Partial update — any field left out keeps its current value. Most importantly, omitting the credential block (ses_credentials/scaleway_credentials/smtp_credentials) preserves the stored secret, so operators can rename a provider without re-typing passwords. provider_type is immutable; to switch providers, delete and recreate.

patch/email-providers/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/email-providers/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Provider ID

Request body

is_activeboolean nullable
namestring nullable
regionstring nullable
sns_topic_arnstring nullable

Rotate or clear the exact SNS topic allowed for this SES provider. Omit to preserve it, send null to clear it, or send a string to set it.

Example request

{
  "name": "My AWS SES",
  "region": "us-east-1",
  "scaleway_credentials": {
    "api_key": "scw-secret-key-12345",
    "project_id": "12345678-1234-1234-1234-123456789012"
  },
  "ses_credentials": {
    "access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "smtp_credentials": {
    "host": "email-smtp.eu-west-1.amazonaws.com",
    "port": 587,
    "username": "AKIAIOSFODNN7EXAMPLE"
  }
}

Response

Provider updated

created_atstring required
credentialsunknown required
idinteger required
is_activeboolean required
namestring required
provider_type'ses' | 'scaleway' | 'smtp' required
regionstring required
sns_topic_arnstring nullable
updated_atstring required

Example response

{
  "created_at": "2025-12-03T10:30:00Z",
  "name": "My AWS SES",
  "region": "us-east-1",
  "updated_at": "2025-12-03T10:30:00Z"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.