Objects

Email Object

ccMe
boolean

Indicates whether to send a copy of the email to the sender.

message
string

The message of the email.

Array of objects or objects

Array of recipients.

subject
string

The subject of the email.

{
  • "ccMe": true,
  • "message": "string",
  • "sendTo": [
    ],
  • "subject": "string"
}

Format Details Object

paperSize
string

Specifies paper size.

Enum: "A0" "A1" "A2" "A3" "A4" "ARCHID" "LEGAL" "LETTER" "WIDE"
{
  • "paperSize": "LETTER"
}

Recipient Object

One of
email
string <email>

The email address of an individual recipient.

{
  • "groupId": 2258118617917316
}

Row Email Object

columnIds
Array of numbers

The Id of the columns to be included.

includeAttachments
boolean

Indicates whether to include attachments in the email.

includeDiscussions
boolean

Indicates whether to include discussions in the email.

layout
boolean

One of the following values: HORIZONTAL or VERTICAL. Optional, defaults to HORIZONTAL when multiple rows are being sent and to VERTICAL when a single row is being sent. HORIZONTAL formats the rows being sent as a grid, whereas VERTICAL formats the rows being sent as separate cards.

ccMe
boolean

Indicates whether to send a copy of the email to the sender.

message
string

The message of the email.

Array of objects or objects

Array of recipients.

subject
string

The subject of the email.

{
  • "columnIds": [
    ],
  • "includeAttachments": true,
  • "includeDiscussions": true,
  • "layout": true,
  • "ccMe": true,
  • "message": "string",
  • "sendTo": [
    ],
  • "subject": "string"
}

Multi Row Email Object

rowIds
Array of numbers

The Ids of rows to be included.

columnIds
Array of numbers

The Id of the columns to be included.

includeAttachments
boolean

Indicates whether to include attachments in the email.

includeDiscussions
boolean

Indicates whether to include discussions in the email.

layout
boolean

One of the following values: HORIZONTAL or VERTICAL. Optional, defaults to HORIZONTAL when multiple rows are being sent and to VERTICAL when a single row is being sent. HORIZONTAL formats the rows being sent as a grid, whereas VERTICAL formats the rows being sent as separate cards.

ccMe
boolean

Indicates whether to send a copy of the email to the sender.

message
string

The message of the email.

Array of objects or objects

Array of recipients.

subject
string

The subject of the email.

{
  • "rowIds": [
    ],
  • "columnIds": [
    ],
  • "includeAttachments": true,
  • "includeDiscussions": true,
  • "layout": true,
  • "ccMe": true,
  • "message": "string",
  • "sendTo": [
    ],
  • "subject": "string"
}

Sheet Email Object

format
string

One of the following values: EXCEL, PDF, or PDF_GANTT.

object
ccMe
boolean

Indicates whether to send a copy of the email to the sender.

message
string

The message of the email.

Array of objects or objects

Array of recipients.

subject
string

The subject of the email.

{
  • "format": "string",
  • "formatDetails": {
    },
  • "ccMe": true,
  • "message": "string",
  • "sendTo": [
    ],
  • "subject": "string"
}
➔ Next to Methods