Sieve Scripts

Activate Sieve Script (Alias Auth)

Activate a Sieve script for the authenticated alias. Only one script can be active at a time.

post/v1/sieve-scripts/{script_id}/activate

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/sieve-scripts/{script_id}/activate
  • Auth: HTTP basic

Path parameters

script_idstring required

Sieve script ID or name

Response

Sieve script activated

idstring required

Unique script identifier

namestring required

Script name

contentstring required

Sieve script content

aliasstring required

Alias ID this script belongs to

is_activeboolean

Whether the script is active

priorityinteger

Script priority (lower = higher priority)

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

objectstring

Example response

{
  "object": "sieve_script"
}

Changes

No recorded changes to this operation across all 1 revision of this API.