Set Alerts Blackout

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/setAlertsBlackout

Use the Set Alerts Blackout to set customer preferences for when messages should not be sent.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

Form Data

apiLogin

string

required

Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency.. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of the account.
Pattern: PAN or PRN
Example: "074103447228"

beginTime

string

required

^([0-1][0-9]|[2][0-3]):[0][0]$

Starting time for alerts to be sent. Set to whole hours only.
Pattern: HH:00
Example: "07:00"

endTime

string

required

^([0-1][0-9]|[2][0-3]):[0][0]$

Time of day alerts must end. Set to whole hours only.
Pattern: HH:00
Example: "22:00"

timeZone

string

enum

required

Time zone offset from Arizona time for beginTime and endTime:

-3 — Hawaii time zone
-2 — Alaska time zone
-1 — Pacific time zone
0 — Mountain time zone
1 — Central time zone
2 — Eastern time zone
3 — Atlantic time zone

Pattern: Integer between -3 and 3
Example: -1

daylightSavings

string

enum

required

Specifies whether to observe daylight savings time.
Pattern: Y or N
Example: "Y"

Allowed:

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default