website logo
Documentation
Guides
Navigate through spaces
Documentation
Guides
⌘K
Overview
Important Concepts
Family Systems
Fields
Products
Calls
Paginated Requests
Basic Authentication
Users
create
create_child
login
get_user_list
get_info
add_product
update
add_email
set_status
Status
create
Webhooks
JavaScript Customization
Docs powered by archbee 
6min

add_email

This adds a presentation of emails to the list of emails which have been previously sent to a user, and the system will not send any emails to your users. You can use this to keep track of emails not sent out through Regpack.

Basic parameters

Name

Type

Required

Description

action

string

true

add_email

clogin_id

integer

true

This is a central login id which identifies a single user between any projects within your organization.

group_id

integer

true

This designates which project the action should be applied towards.

doc

array

true

doc should contain email_list.

email_list

array

true

This should be JSON array which describes the emails you'd like to add to the users email list. See below for more.

email_list parameters

Name

Type

Required

Description

from

string

true

The from address.

to

string

true

The to address. For multiple email addresses use a comma separated email string.

subject

string

true

The subject, can be HTML or plain text.

body

string

true

This should be a string of HTML that defines the body, although you can use plain text if desired.

cc

string

false

The cc address. For multiple email addresses use a comma separated email string.

bcc

string

false

The bcc address. For multiple email addresses use a comma separated email string.

admin_id

numeric

false

Allows you to specify which admin sent out the email. The system will validate the admin's level and their access to that project to ensure only authorized admins can be set as the sender.

Example

Curl
Python
|



Response

JSON
|



Updated 20 Apr 2022
Did this page help you?
Yes
No
UP NEXT
set_status
Docs powered by archbee 
TABLE OF CONTENTS
Basic parameters
email_list parameters
Example
Response