API Reference

Create a batch of vouchers.

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/vouchers/batch

Batch process helps to add multiple vouchers in one request.
⚠️ Adjust batch sizes based on processing times. We recommended use maximum amount of 1000 records and adjust the batch size based on processing time.
⚠️ Endpoint is available only in Enterprise interface.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
vouchers
array of objects
required

List of the CareCloud vouchers.

vouchers*
integer
enum

The parameter describes the batch method behavior in case of error occurs. Possible values are: 1 - It returns the first error found and rollback all previous changes (this is also the default behavior if the parameter is not set) / 2 - It creates all valid records and creates an error report from failed attempts.

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses
204

No Content

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 25 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago