EmailMessageLink v1.2

Provides the links contained within an emailMessage.

GET /emailMessageLink or /emailMessageLink/:id

AttributeTypeFilterSortDescription
id

int

Yes

Yes

Unique ID of the message link.

message_id
intYesNoID of the message.
name
string/nullNoNoFor personalised links, the name assigned to the link.
target

string

No

No

Link destination URL.

task_id
intYesNoUnique ID of the task.
type
enumYesNoMessage part containing the link - "html" / "text".
cdate

decimal

No

Yes

Creation timestamp.

HEAD /emailMessageLink or /emailMessageLink/:id

AttributeTypePresenceDescription
id

int

Optional

Unique ID of the message link.

message_id
intOptionalID of the message.
task_id
intOptionalUnique ID of the task.
type
enumOptionalMessage part containing the link - "html" / "text".

POST /emailMessageLink

This method is not supported.

PUT /emailMessageLink or /emailMessageLink/:id

This method is not supported.

DELETE /emailMessageLink or /emailMessageLink/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":         53659,
    "message_id": 52699,
    "name":       "Example link name",
    "target":     "http://www.example.com/",
    "task_id":    50655,
    "type":       "html",
    "cdate":      1234966741,
}