Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Update All Credit Alerts on a Sub-Account

POST https://accounts.resumeparsing.com/api/(accountId)/creditalert

Update all credit alerts on a sub-account.

Path Parameters

ParameterData TypeDescription
accountidstringThe AccountId to allocate credits to.

Request Body

CreditThresholdsoptionalinteger[]
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 Request

{ ... 
[ ... 
0,1000
]
}

Response Body

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

Sample Response

{ ... 
"ErrorMessage" :  "string"
}

Add Single Credit Alerts to a Sub-Account

POST https://accounts.resumeparsing.com/api/(accountId)/creditalert/(threshold)

Add a credit alert threshold to the sub-account.

Path Parameters

ParameterData TypeDescription
accountidstringThe AccountId to allocate credits to.
thresholdintegerCredit 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

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

Sample Response

{ ... 
"ErrorMessage" :  "string"
}

Remove Single Credit Alerts from a Sub-Account

DELETE https://accounts.resumeparsing.com/api/(accountId)/creditalert/(threshold)

Removes a credit alert threshold from a sub-account.

Path Parameters

ParameterData TypeDescription
accountidstringThe AccountId to allocate credits to.
thresholdintegerCredit threshold to remove a credit alert email for.

Response Body

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

Sample Response

{ ... 
"ErrorMessage" :  "string"
}