Alert Subscription Create V1

post

https://processor-api.uat1.pcaasa.com/?call=alert-subscription-create-v1

Subscribe to an alert

Body Params

app

string

Defaults to customer-alert

customer-alert

object

string

Defaults to alert-subscription

alert-subscription

action

string

Defaults to create

create

version

int32

Defaults to 1

sessionUuid

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

externalTranUuid

string

Identifier for tracking this API call

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

alertUuid

string

The unique identifier belonging to the alert to which a subscriber is being added

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

type

string

enum

The type of subscription being added to an alert. The list of valid values are:
sms
email

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

Allowed:

targetAddress

string

phone number or email address to which an alert will be sent

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

debug

boolean

Defaults to false

debug

Response

Language

Response

Choose an example:

application/json

200200