unsubscribe

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

Overview

Name	unsubscribe
Type	Resource
Id	cloudflare.alerting.unsubscribe

Fields

The following fields are returned by SELECT queries:

list

Show email unsubscribe details response

Name	Datatype	Description
id	string	The unique identifier of a notification policy (example: 0da2b59ef118439d8097bdfb215203c9)
name	string	Name of the policy. (example: SSL Notification Event Policy)
account_id	string	The account id (example: 023e105f4ecef8ad9ca31a8372d0c353)
email	string (email)
token	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, policy_id	email, token	Shows details for unsubscribing an email address from a notification policy.
notification_policies_unsubscribe_email_from_notification_policy	insert	account_id, policy_id	email, token	Unsubscribes an email address from a notification policy.

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.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
policy_id	string	The Access policy ID.
email	string (email)
token	string

SELECT examples

list

Shows details for unsubscribing an email address from a notification policy.

SELECT
id,
name,
account_id,
email,
token
FROM cloudflare.alerting.unsubscribe
WHERE account_id = '{{ account_id }}' -- required
AND policy_id = '{{ policy_id }}' -- required
AND email = '{{ email }}'
AND token = '{{ token }}'
;

INSERT examples

notification_policies_unsubscribe_email_from_notification_policy

Unsubscribes an email address from a notification policy.

INSERT INTO cloudflare.alerting.unsubscribe (
account_id,
policy_id,
email,
token
)
SELECT 
'{{ account_id }}',
'{{ policy_id }}',
'{{ email }}',
'{{ token }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: unsubscribe
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the unsubscribe resource.
  - name: policy_id
    value: "{{ policy_id }}"
    description: Required parameter for the unsubscribe resource.
  - name: email
    value: "{{ email }}"
  - name: token
    value: "{{ token }}"