customer-alert

alert

search

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

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

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
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
Current valid object types:
Holding Company
Company
Account
Account User
Payment Instrument
Plastic
Card**
If objectReferenceNumber has been provided, objectType will be required
Vaild special character: space ' '

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

The code for the alert type being searched

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