Skip to main content
POST
Create a new voucher group

Body

application/json

The voucher group to be created.

name
string
required

The voucher group name.

Maximum string length: 30
Example:

"Premium Voucher Group"

pricing
object
required

With a voucher applied, the drivers charges at a lowered price overwriting the standard tariff on the location.

Example:
customerId
number
required

Customer the voucher group will be created for.

Example:

2001

notes
string

Optional comment about the voucher.

Maximum string length: 30
Example:

"This is a comment."

Response

201 - application/json

The voucher group has been successfully created.

id
number
required

Unique identifier for the voucher group.

Example:

1

name
string
required

The voucher group name.

Maximum string length: 30
Example:

"Premium Voucher Group"

pricing
object
required

With a voucher applied, the drivers charges at a lowered price overwriting the standard tariff on the location.

Example:
createdAt
string<date-time>
required

The date and time when the voucher group was created.

Example:

"2025-06-03T12:00:00.000Z"

updatedAt
string<date-time>
required

The date and time when the voucher group was last updated.

Example:

"2025-06-03T12:00:00.000Z"

customerId
number | null

The CRM customer ID the voucher group belongs to.

notes
string

Optional comment about the voucher.

Maximum string length: 30
Example:

"This is a comment."

deletedAt
string<date-time> | null