Create Unique Code Group

Overview

Unique Code Groups are containers for vouchers, they are typically related to a specific campaign or promotion and the group will contain all unique voucher codes for that specific campaign or promotion.
When creating a unique code group, no unique vouchers will be generated. This is a manual process that will require Airship customer success to generate them.

Example Request

POST
1
https://api.airship.co.uk/v1/unique_code/group
Copied!

Configuration

Headers

Field
Notes
Authentication (bearer token)
The authentication token is linked to the account that you are searching bookings in. If you are unsure of what your Authentication token is, ask our support team to confirm.

Body

Field
Notes
account_id
The account ID represents the account that you are searching bookings in. If you are unsure of what your account ID is, ask our support team to confirm.
unit_id
Airship has predefined locations or "units" to store contacts for different physical locations. The units object represents which location which the voucher code group to be created against. You can fetch a list of units for your account using the account/unitsendpoint.
Typically code groups are created against the Head Office account, but check with Airship Customer Services if you are unsure.
name
A text descriptive name is required against the code group. The unique code group name must be unique against the Account > Unit. An error will be returned if the group name already exists.

Example Payload

Request
200 Response
422 Response
1
{
2
"account_id": 2,
3
"unit_id": 14212,
4
"name": "test group"
5
}
Copied!
1
{
2
"id": 10616
3
}
Copied!
  1. 1.
    Duplicate group name
1
{
2
"message": "The given data was invalid.",
3
"errors": {
4
"name": [
5
"Sorry, You've all ready used this name on another unique code group in this unit."
6
]
7
}
8
}
Copied!
2. Invalid unit ID
1
{
2
"message": "The given data was invalid.",
3
"errors": {
4
"unit_id": [
5
"Unit ID 2 does not exist or has been deleted on this account"
6
],
7
"name": [
8
"In order to add a name the unit id must also be correct"
9
]
10
}
11
}
Copied!
3. Invalid account ID
1
{
2
"message": "The given data was invalid.",
3
"errors": {
4
"account_id": [
5
"You do not have access to this account"
6
]
7
}
8
}
Copied!