Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Batch Request Endpoints

batch/contacts/add

This endpoint is used to submit multiple contact creation requests to VoPay. Each object in the batch is processed against the /contacts/add endpoint: EmailAddress and PhoneNumber are always required, and either BusinessName or both FirstName and LastName must be provided.

post/batch/contacts/add

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

BatchTransactionRequestIDinteger required

Unique ID of your batch transaction request.

TotalSubmittedTransactionsinteger required

Total number of contacts submitted.

NumberOfRejectedTransactionsinteger required

Total number of rejected contacts.

RejectedTransactionsstring

JSON object containing the rejected contacts

Example response

{
  "Success": true,
  "RejectedTransactions": "{'1': 'Required parameter(s) missing: EmailAddress', '3': 'Required parameter(s) missing: FirstName, LastName'}"
}