Get Default Verify SMS OTP Message Text

GET 
https://$CUSTOM-DOMAIN/admin/v1/text/default/message/verifysmsotp/:language

Get the default text of the verify SMS OTP message that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when an SMS One-time password should be verified and a notification provider is configured.

Request

Path Parameters

language stringrequired

Responses

200

A successful response.

application/json

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 (string)

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

Example (from schema)

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-05T15:24:33.713Z",
      "changeDate": "2025-03-05T15:24:33.713Z",
      "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
  }
}

application/grpc

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 (string)

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

Example (from schema)

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-05T15:24:33.713Z",
      "changeDate": "2025-03-05T15:24:33.713Z",
      "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
  }
}

application/grpc-web+proto

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 (string)

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

Example (from schema)

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-05T15:24:33.714Z",
      "changeDate": "2025-03-05T15:24:33.714Z",
      "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
  }
}

403

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

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

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

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Auth

Bearer Token

Parameters

language — pathrequired

ResponseClear

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