Alert Create V1

Create an alert

Body Params
string
Defaults to customer-alert

customer-alert

string
Defaults to alert

alert

string
Defaults to create

create

int32
Defaults to 1

1

string

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

string

Identifier for tracking this API call

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

string

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

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

string

The reference number of the object being connected to the alert
If 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

string
enum

bject type from which the spend control will be copied
If the objectReferenceNumber is provided, objectType will be required

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

Allowed:
string
enum

The code for the alert type being created

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

Allowed:
boolean
Defaults to false

Determines if the existing active alert will be replaced. Defaults to 0

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

date

Special characters allowed:
hyphen (-)
colon (:)
period (.)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

date

Special characters allowed:
hyphen (-)
colon (:)
period (.)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

int32
Defaults to 0

Allowed range is -12 to 14

Data type: number
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 3

float



Data type: money
Required: no
Letters: no
Numbers: yes
Special: no
Min: 3
Max: 25

int32



Data type: number
Required: no
Letters: no
Numbers: yes
Special: no
Min: 3
Max: 10

string

Vaild special character: space (' ')

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

string

Invaild special character: comma (,)

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

boolean
Defaults to false


0 = debug off
1 = debug on
Default is set to 0

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

Response

Language
Response
Choose an example:
application/json