customer-alert

alert

delete

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 connected to the alert
If alertUuid or objectReferenceNumber is not provided, objectUuid will be required
If objectUuid is provided and deleteAll is '0', alertTypeCode will be required

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

The reference number of the object being connected to the alert
If alertUuid or objectUuid is not provided, objectReferenceNumber will be required
If objectReferenceNumber is the only identifier provided, the objectType will be required
If objectReferenceNumber is provided and deleteAll is '0', alertTypeCode 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

The type of object to which the object identifier belongs (i.e. Account, Account User, etc.)
If the objectReferenceNumber 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 deleted.
If alertUuid is not provided, alertTypeCode will be required
If deleteAll = '1', alertTypeCode will not be allowed

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