customer-alert

alert

update

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

Unique identifier for the alert being updated. Not the record uuid. If the objectUuid or objectReferenceNumber is not provided, alertUuid will be required

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

The unique identifier of the object to which the alert is connected
If alertUuid or objectReferenceNumber is not provided, objectUuid will be required

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

The reference number of the object to which the alert is connected
If alertUuid or objectUuid is not provided, objectReferenceNumber will be required
Reference number format and length will vary depending on the object which it belongs to
Some allow alphaNumeric values, some only numeric and one capital alpha
Special characters allowed by some referenceNumbers: , . (comma, space, period)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 5
Max: 50

Object type to which the alert is attached
If the objecteferenceNumber is the only identifier provided, objectType will be required

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 40

The code for the alert type being updated. If alertUuid is not provided, alertTypeCode will be required

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 3
Max: 50

Vaild special character: space (' ')

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 4
Max: 4000

Invaild special character: comma (,)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 4
Max: 4000