Skip to main content

Update SMTP Configuration​

Update the SMTP configuration, be aware that this will be activated as soon as it is saved. So the users will get notifications from the newly configured SMTP.

Path Parameters
    id string required
Request Body required
    senderAddress string required

    Possible values: non-empty and <= 200 characters

    senderName string required

    Possible values: non-empty and <= 200 characters

    tls boolean
    host string required

    Possible values: non-empty and <= 500 characters

    Make sure to include the port.

    user string
    replyToAddress string

    Possible values: non-empty and <= 200 characters

    password string
    description string

    Possible values: non-empty and <= 200 characters

Responses

A successful response.

Schema
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to
PUT /smtp/:id

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
id — path required
Content-Type
Body required
{

  "senderAddress": "noreply@m.zitadel.cloud",

  "senderName": "ZITADEL",

  "tls": true,

  "host": "smtp.postmarkapp.com:587",

  "user": "197f0117-529e-443d-bf6c-0292dd9a02b7",

  "replyToAddress": "replyto@m.zitadel.cloud",

  "password": "this-is-my-password",

  "description": "provider description"

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "senderAddress": "noreply@m.zitadel.cloud",
  "senderName": "ZITADEL",
  "tls": true,
  "host": "smtp.postmarkapp.com:587",
  "user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "password": "this-is-my-password",
  "description": "provider description"
}'