Method: organizations.sites.send-test-email

Sends a test email using the email template.

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*/sites/*}/send-test-email

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the portal. Use the following structure in your request: organizations/{org}/sites/{site}

Request body

The request body contains an instance of SendTestEmailPayload.

Response body

If successful, the response body contains an instance of ApiResponseWrapper.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

SendTestEmailPayload

JSON representation
{
  "emailTemplateId": string,
  "to": string
}
Fields
emailTemplateId

string

ID of the email template.

to

string

Email address to which the test email is sent.