Update Communication

User Guide > Resources > Update Communication

This request changes the attributes of a communication.

Resource

PATCH /communications/<OID>

Where OID is the object ID of the communication.

Parameters

None

Payload

Patch Document

Fields

name Patch Operations Notes

flagged

replace

Flagged communication will also be set on the todo/flagged list

processed

replace

displayed

replace

processed

replace

retrieved

replace

subject

replace

afterCallType

replace

participants

add, remove

contents

replace

attachments

add, remove

packetsLogs

add, remove, replcae submember

Response

None

Context

Authorization

User

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/communications/10317713
Payload

change communication direct member

{
    "operations": [
            {
        "op": "replace",
            "path": "/flagged",
            "value": true
            }
    ]
}

add new attachment to the communication, first add a path with a virtual id '1' and insert the oid of the attachment as value

{
    "operations": [
            {
        "op": "add",
            "path": "/attachments/1",
            "value": "1756113"
            }
    ]
}

remove a attachment from the communication, <OID> is the oid of the message attachment object

{
     "operations": [
            {
            "op": "remove",
            "path": "/attachments/321443"
            }
    ]
}

change the field of a packetsLogs object from communication, <OID> is the oid of the packetsLogs object

{
        "operations": [
            {
                "op": "replace",
                "path": "/packetsLogs/1809540/meanJitterDeviation",
                "value": 5
            }
    ]
}