- Auth
- Account Ledger
- Activity Log
- Announcement
- Asset
- Sales
- GetTotalRevenue
- GetTotalReceivables
- GetTotalInwardPayment
- GetTotalOverDuePayment
- SalesRatio
- GetGrowthByMonth
- GetGrowthByQuarter
- GetGrowthByYear
- GetSnapshotReceivables
- GetSalesByInvoiceTypes
- GetIncomeByInvoiceTypes
- GetGstInvoices
- GetRecurringInvoices
- GetClientsAcquired
- GetSalesByMonthGraph
- GetSalesByYearGraph
- GetSalesByProductGraph
- GetSalesByServiceGraph
- GetSalesByClientGraph
- GetSalesByCountryGraph
- GetSalesByUserGraph
- GetRevenueBySource
- GetSalesByRegionGraph
- Client
- Client Ledger
- CreditNote
- Cron-jobs
- Currency Conversion
- Document
- Discount
- Employee
- GetEmployeesByMonth
- GetEmployees
- AddEmployee
- GetEmployeeDetail
- UpdateEmployee
- DeleteEmployee
- FileImport
- UpdateSalaryComponent
- UpdateFileUrl
- UpdateInvoiceNumber
- PrepareSalaryComponents
- UpdateEmployeeName
- UpdateEmployeeEmail
- UpdateEmployeePhone
- UpdateEmployeeDob
- UpdateEmployeeLocation
- UpdateEmployeePanNumber
- UpdateEmployeeAdharNumber
- UpdateEmployeeEsiNumber
- UpdateEmployeeEpsNumber
- UpdateEmployeeUanNumber
- UpdateEmployeePfNumber
- UpdateEmployeeCountry
- UpdateEmployeeBankAccountDetails
- UpdateEmployeeCurrentAddress
- UpdateEmployeePermanentAddress
- LinkUser
- UpdateEmployeeDocumentInfo
- UpdateEmployeeProfilePicture
- Email
- Expense
- File
- Hr
- Inventory Ledger
- Invoice
- Item
- Organization
- GetOrganizations
- AddOrganization
- UpdateOrganization
- GetOrganizationDetail
- DeleteOrganization
- UpdateOrganizationBusinessProfile
- ExtendSubscription
- UpdateGSTDetails
- UpdateVATDetails
- UpdateInvoiceOnOrderSetting
- UpdateReminderSetting
- UpdateInvoiceSettings
- UpdatePurchaseOrderSettings
- UpdateProposalSettings
- UpdatePreferences
- GetOrganizationPreferences
- UpdatePaymentSettings
- UpdateDefaultPaymentSettings
- UpdateLogo
- UpdateFromEmail
- OrganizationDeactive
- GetOrganizationSubscriptions
- GetOrganizationDashboardView
- GetOrganizationDashboardSnapshot
- GetSnapshotReceivables
- DeleteSelectiveData
- DeletePermanent
- GetClientCountries
- GetVendorCountries
- GetLeadCountries
- InviteUsers
- AcceptInvitation
- UpdatePlatformCredits
- UpdateCreditNoteSettings
- UpdateDebitNoteSettings
- Order
- Outward Payment
- Operations
- Payment
- Product
- Proposal
- Platform Plan
- Platform Subscription
- Platform Payment
- ProductCategory
- Purchase Order
- Purchase
- Recurring Expense
- Recurring Invoice
- Report
- GetSalesByClient
- GetSalesByProduct
- GetSalesByProductCategory
- GetSalesByService
- GetSalesByMonth
- GetSalesByYear
- GetSalesByQuarter
- GetSalesByCountry
- GetTaxSummary
- GetInvoiceDetailReport
- GetExpensesByMonth
- GetProfitAndLossReportV2
- GetBalanceSheetReport
- GetTrialBalanceReport
- GetGeneralLedger
- GetSalesByHsn
- GetTaxesByMonth
- GetOtherSales
- Routes
- Settlement
- Services
- Tax
- Trip
- User
- User Invites
- Vendor
- Vendor Ledger
- Projects
- Pre Sales
- Task
- Payroll
- Account
- Enquiry
- Account Transfer
- File Import
- File Import Error
- Brand
- Salary Component
- Leaves Configuration
- Tax Calendar
- Contract
- GST-Reports
- Organization Backup
- Bank Account
- Leave Policy
- Leave Application
- Backup Restore
- Finance
- Email-Rule
- Widget
- User Dashboard
- ExpenseCategory
- Lead
- LeadActivity
- Deal
- DebitNote
- SpendCategory
- SpendPolicy
- Employee Spend
- Warehouse
- Branch
UpdateEmailRule
PUT
https://api.upbooks.io/api/v1/email-rule/{id}
Email-Rule
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
id
stringÂ
required
Header Params
ORGANIZATION-ID
stringÂ
optional
Example:
00000
Body Params application/json
name
stringÂ
required
toEmail
array[string]
required
filters
object (IEmailRulesFilter)Â
required
subject
optional
body
optional
fromEmail
optional
ccEmail
optional
hasAttachment
boolean  | nullÂ
optional
Example
{
"name": "string",
"toEmail": [
"string"
],
"filters": {
"subject": {
"operator": "contains",
"value": "string"
},
"body": {
"operator": "contains",
"value": "string"
},
"fromEmail": {
"operator": "contains",
"value": "string"
},
"ccEmail": {
"operator": "contains",
"value": "string"
},
"hasAttachment": true
}
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.upbooks.io/api/v1/email-rule/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "string",
"toEmail": [
"string"
],
"filters": {
"subject": {
"operator": "contains",
"value": "string"
},
"body": {
"operator": "contains",
"value": "string"
},
"fromEmail": {
"operator": "contains",
"value": "string"
},
"ccEmail": {
"operator": "contains",
"value": "string"
},
"hasAttachment": true
}
}'Responses
🟢200Ok
application/json
Body
data
object (IEmailRuleDocumentJSON)Â
required
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
__v
number <double>
optional
_id
stringÂ
required
organizationId
stringÂ
required
addedBy
object (ICommonUser)Â
required
date
string <date-time>
required
name
stringÂ
required
toEmail
array[string]
required
filters
object (IEmailRulesFilter)Â
required
isDeleted
boolean  | nullÂ
optional
message
stringÂ
optional
Example
{
"data": {
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0,
"_id": "string",
"organizationId": "string",
"addedBy": {
"id": "string",
"name": "string",
"email": "string",
"organizations": [
{
"organizationHashId": "string",
"organizationId": "string",
"role": "organization-admin",
"teams": [
"admin"
],
"organizationName": "string",
"organizationLogo": "string",
"isActive": true
}
]
},
"date": "2019-08-24T14:15:22Z",
"name": "string",
"toEmail": [
"string"
],
"filters": {
"subject": {
"operator": "contains",
"value": "string"
},
"body": {
"operator": "contains",
"value": "string"
},
"fromEmail": {
"operator": "contains",
"value": "string"
},
"ccEmail": {
"operator": "contains",
"value": "string"
},
"hasAttachment": true
},
"isDeleted": true
},
"message": "string"
}🟢200Success
Modified at 2024-04-16 04:16:55