Skip to content
Tx Platform
Credit Alerts

Update All Credit Alerts on a Sub-Account🔗︎

HTTP Verb Path
POST https://api.us.textkernel.com/tx/accounts/api/(accountId)/creditalert

Update all credit alerts on a sub-account.

Path Parameters🔗︎

Parameter Data Type Description
accountid string The AccountId to allocate credits to.

Request Body🔗︎

CreditThresholds 🔗︎ integer[] required

CreditThresholds🔗︎

Array of credit values to trigger credit alert emails for. When the account reaches or goes below each of these values, you will be sent an email about the account's credit status. This will overwrite any existing credit alerts. If this array is empty, all credit alerts will be cleared and you will no longer recieve emails.

Sample JSON
{
  "CreditThresholds": [
    0,
    1000
  ]
}

Response Body🔗︎

ErrorMessage 🔗︎ string

ErrorMessage🔗︎

If an error occured, this will give a detailed message on what happened. If no error occured, this will be empty.

Sample JSON
{
  "ErrorMessage": "string"
}

Add Single Credit Alerts to a Sub-Account🔗︎

HTTP Verb Path
POST https://api.us.textkernel.com/tx/accounts/api/(accountId)/creditalert/(threshold)

Add a credit alert threshold to the sub-account.

Path Parameters🔗︎

Parameter Data Type Description
accountid string The AccountId to allocate credits to.
threshold integer Credit value to trigger credit alert email for. When the account reaches or goes below this value, you will be sent an email about the account's credit status.

Response Body🔗︎

ErrorMessage 🔗︎ string

ErrorMessage🔗︎

If an error occured, this will give a detailed message on what happened. If no error occured, this will be empty.

Sample JSON
{
  "ErrorMessage": "string"
}

Remove Single Credit Alerts from a Sub-Account🔗︎

HTTP Verb Path
DELETE https://api.us.textkernel.com/tx/accounts/api/(accountId)/creditalert/(threshold)

Removes a credit alert threshold from a sub-account.

Path Parameters🔗︎

Parameter Data Type Description
accountid string The AccountId to allocate credits to.
threshold integer Credit threshold to remove a credit alert email for.

Response Body🔗︎

ErrorMessage 🔗︎ string

ErrorMessage🔗︎

If an error occured, this will give a detailed message on what happened. If no error occured, this will be empty.

Sample JSON
{
  "ErrorMessage": "string"
}