Skip to main content

email_customizations

Creates, updates, deletes, gets or lists an email_customizations resource.

Overview

Nameemail_customizations
TypeResource
Idokta.org.email_customizations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
bulk_remove_email_address_bouncesexecsubdomainRemoves emails from an email service bounce list.

The emails submitted in this operation are removed from the bounce list by an asynchronous job.
Any email address that passes validation is accepted for the removal process, even if there are other email addresses in the request that failed validation.

> Note: If there are validation errors for all email addresses, a 200 OK HTTP status is still returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
subdomainstringThe domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

Lifecycle Methods

Removes emails from an email service bounce list.

The emails submitted in this operation are removed from the bounce list by an asynchronous job.
Any email address that passes validation is accepted for the removal process, even if there are other email addresses in the request that failed validation.

> Note: If there are validation errors for all email addresses, a 200 OK HTTP status is still returned.

EXEC okta.org.email_customizations.bulk_remove_email_address_bounces 
@subdomain='{{ subdomain }}' --required
@@json=
'{
"emailAddresses": "{{ emailAddresses }}"
}'
;