Update SMTP Password​
Update the SMTP password that is used for the host, 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
application/json
application/grpc
application/grpc-web+proto
Request Body required
password string
Request Body required
password string
Request Body required
password string
Responses
- 200
- 403
- 404
- default
A successful response.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T12:33:11.620Z",
"changeDate": "2024-06-13T12:33:11.620Z",
"resourceOwner": "69629023906488334"
}
}
Schema
Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T12:33:11.620Z",
"changeDate": "2024-06-13T12:33:11.620Z",
"resourceOwner": "69629023906488334"
}
}
Schema
Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T12:33:11.620Z",
"changeDate": "2024-06-13T12:33:11.620Z",
"resourceOwner": "69629023906488334"
}
}
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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
PUT /smtp/:id/password
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "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
Request
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
python / requests
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
go / native
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
nodejs / axios
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
ruby / Net::HTTP
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
csharp / RestSharp
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
php / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
java / OkHttp
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'
powershell / RestMethod
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/smtp/:id/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"password": "this-is-my-updated-password"
}'