Get Default Verify Email OTP Message Text

Get the default text of the verify Email OTP message that is set on the instance or as translation files in ZITADEL itself. The message is sent when an Email One-time password should be verified and a notification provider is configured.

Path Parameters

language string required

Header Parameters

x-zitadel-orgid string

The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Responses

• 200
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

customText object
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
title string
custom text for email title
preHeader string
custom text for email pre-header
subject string
custom text for email subject
greeting string
custom text for email greeting
text string
custom text for email text
buttonText string
custom text for email button_text
footerText string
custom text for email footer_text
isDefault boolean

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-05-24T10:54:22.218Z",
      "changeDate": "2024-05-24T10:54:22.218Z",
      "resourceOwner": "69629023906488334"
    },
    "title": "ZITADEL - Message Title",
    "preHeader": "User Message",
    "subject": "Message Subject",
    "greeting": "Hello {{.FirstName}} {{.LastName}},",
    "text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
    "buttonText": "Call to action",
    "footerText": "",
    "isDefault": true
  }
}

Schema

Example (from schema)

---

Schema

customText object
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
title string
custom text for email title
preHeader string
custom text for email pre-header
subject string
custom text for email subject
greeting string
custom text for email greeting
text string
custom text for email text
buttonText string
custom text for email button_text
footerText string
custom text for email footer_text
isDefault boolean

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-05-24T10:54:22.218Z",
      "changeDate": "2024-05-24T10:54:22.218Z",
      "resourceOwner": "69629023906488334"
    },
    "title": "ZITADEL - Message Title",
    "preHeader": "User Message",
    "subject": "Message Subject",
    "greeting": "Hello {{.FirstName}} {{.LastName}},",
    "text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
    "buttonText": "Call to action",
    "footerText": "",
    "isDefault": true
  }
}

Schema

Example (from schema)

---

Schema

customText object
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
title string
custom text for email title
preHeader string
custom text for email pre-header
subject string
custom text for email subject
greeting string
custom text for email greeting
text string
custom text for email text
buttonText string
custom text for email button_text
footerText string
custom text for email footer_text
isDefault boolean

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-05-24T10:54:22.218Z",
      "changeDate": "2024-05-24T10:54:22.218Z",
      "resourceOwner": "69629023906488334"
    },
    "title": "ZITADEL - Message Title",
    "preHeader": "User Message",
    "subject": "Message Subject",
    "greeting": "Hello {{.FirstName}} {{.LastName}},",
    "text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
    "buttonText": "Call to action",
    "footerText": "",
    "isDefault": true
  }
}

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"
    }
  ]
}

GET /text/default/message/verifyemailotp/:language

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/management/v1

Bearer Token

language — path required

x-zitadel-orgid — header

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/text/default/message/verifyemailotp/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'