Skip to main content

Update SMTP Email provider

PUT 
https://$CUSTOM-DOMAIN/admin/v1/email/smtp/:id

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

Request​

Path Parameters

    id stringrequired

Body

required

    senderAddress stringrequired

    Possible values: non-empty and <= 200 characters

    senderName stringrequired

    Possible values: non-empty and <= 200 characters

    tls boolean
    host stringrequired

    Possible values: non-empty and <= 500 characters

    Make sure to include the port.

    user string
    replyToAddress string

    Possible values: <= 200 characters

    password string
    description string

    Possible values: <= 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 (string)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/email/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"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Parameters
— pathrequired
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"
}
ResponseClear

Click the Send API Request button above and see the response here!