Add SMTP Configuration

Add a new SMTP configuration if nothing is set yet.

application/json

application/grpc

application/grpc-web+proto

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
password string
replyToAddress string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

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
password string
replyToAddress string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

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
password string
replyToAddress string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

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
id string

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-06-11T10:37:15.680Z",
    "changeDate": "2024-06-11T10:37:15.680Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

Schema

Example (from schema)

---

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
id string

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-06-11T10:37:15.680Z",
    "changeDate": "2024-06-11T10:37:15.680Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

Schema

Example (from schema)

---

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
id string

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-06-11T10:37:15.680Z",
    "changeDate": "2024-06-11T10:37:15.680Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

POST /smtp

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

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "senderAddress": "noreply@m.zitadel.cloud",
  "senderName": "ZITADEL",
  "tls": true,
  "host": "smtp.postmarkapp.com:587",
  "user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-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",
  "password": "this-is-my-password",
  "replyToAddress": "replyto@m.zitadel.cloud",
  "description": "provider description"
}'