UpdateEmailRule - Upbooks API

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

OrganizationId of your registered business on upbooks

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

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