Skip to content

Send Signup Email.

POST
/no_auth/namespaces/system/f5xc-saas/signup/send_email
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/no_auth/namespaces/system/f5xc-saas/signup/send_email \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "token": "example" }'

Use this API to send a tenant provisioning signup email when the signup URL link in the previously sent email has expired or is no longer accessible.

Examples of this operation.

Media typeapplication/json
SendSignupEmailRequest

The request message for SendSignupEmail.

object
token
token

The token contains the encrypted data, secured using an HMAC key.

string
<= 1024 characters
Examplegenerated
{
"token": "example"
}

A successful response.

Media typeapplication/json
SendEmailResponse

Response to indicate if the email was sent successfully.

object
message
message

Message provides additional context regarding the result of the email send operation.

string
<= 1024 characters
success
success

Indicates if the email was sent successfully.

boolean format: boolean
Examplegenerated
{
"message": "example",
"success": true
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example