BI Helper APIs

Email Configuration

Endpoint:https://bihelper-main-a2097e9.zuplo.app

Email task and notification configuration

Get job email configuration

GET

https://bihelper-main-a2097e9.zuplo.app

/api/job-email-config

Get email configuration for a specific job

Get job email configuration › query Parameters

userJobIdinteger · int64 · required
User Job ID

Get job email configuration › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get job email configuration › Responses

Email configuration saved

idinteger · int64
fromEmailstring · email
Sender email address
isActiveboolean
Whether email task is active
emailBodystring
Email body content
emailTitlestring
Email subject
emailSignaturestring
Email signature
userJobIdinteger · int64
Associated job ID

Save job email configuration

POST

https://bihelper-main-a2097e9.zuplo.app

/api/job-email-config

Configure email settings for a specific job

Save job email configuration › query Parameters

userJobIdinteger · int64 · required
User Job ID

Save job email configuration › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Save job email configuration › Request Body

idinteger · int64
fromEmailstring · email
Sender email address
isActiveboolean
Whether email task is active
emailBodystring
Email body content
emailTitlestring
Email subject
emailSignaturestring
Email signature
userJobIdinteger · int64
Associated job ID

Save job email configuration › Responses

Email configuration saved

idinteger · int64
fromEmailstring · email
Sender email address
isActiveboolean
Whether email task is active
emailBodystring
Email body content
emailTitlestring
Email subject
emailSignaturestring
Email signature
userJobIdinteger · int64
Associated job ID

Filter Management Product Usage