Resend the contact email code

Resend the email with the verification code for the contact email address.

Path Parameters

userId string required

unique identifier of the user.

application/json

application/grpc

application/grpc-web+proto

Request Body required

sendCode object

Let ZITADEL send the link to the user via email.

urlTemplate string

Possible values: non-empty and <= 200 characters

Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

returnCode object

Get the code back to provide it to the user in your preferred mechanism.

Request Body required

sendCode object

Let ZITADEL send the link to the user via email.

urlTemplate string

Possible values: non-empty and <= 200 characters

Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

returnCode object

Get the code back to provide it to the user in your preferred mechanism.

Request Body required

sendCode object

Let ZITADEL send the link to the user via email.

urlTemplate string

Possible values: non-empty and <= 200 characters

Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

returnCode object

Get the code back to provide it to the user in your preferred mechanism.

Responses

• 200
• 403
• 404
• default

---

Code resend successfully requested

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
verificationCode string

in case the verification was set to return_code, the code will be returned.

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-13T12:33:10.740Z",
    "resourceOwner": "69629023906488334"
  },
  "verificationCode": "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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
verificationCode string

in case the verification was set to return_code, the code will be returned.

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-13T12:33:10.740Z",
    "resourceOwner": "69629023906488334"
  },
  "verificationCode": "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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
verificationCode string

in case the verification was set to return_code, the code will be returned.

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-13T12:33:10.740Z",
    "resourceOwner": "69629023906488334"
  },
  "verificationCode": "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 /v3alpha/users/:userId/email/resend

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

Bearer Token

userId — path required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/email/resend' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {}
}'