Create a group

curl --request POST \
  --url https://api.voucher-staging.allride.io/partner/v1/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Analysts"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Analysts'})
};

fetch('https://api.voucher-staging.allride.io/partner/v1/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.voucher-staging.allride.io/partner/v1/groups"

payload = { "name": "Analysts" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/groups")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Analysts\"\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/partner/v1/groups"

	payload := strings.NewReader("{\n  \"name\": \"Analysts\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Analysts'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 14070,
    "resource": "group",
    "partnerId": 1069,
    "key": null,
    "name": "Analysts",
    "description": "Read statistics.",
    "permissions": [
      "view-profile",
      "view-consumer-analytics"
    ],
    "permissionsComputed": false,
    "isSystem": false,
    "status": "active",
    "memberCount": 1,
    "createdAt": "2026-10-22T09:00:00Z",
    "updatedAt": "2026-10-22T09:00:00Z",
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/partner/v1/groups/14070",
        "type": "application/json"
      },
      "members": {
        "href": "https://api.voucher.allride.io/partner/v1/groups/14070/members",
        "type": "application/json"
      }
    }
  }
}

POST

partner

groups

Create a group

curl --request POST \
  --url https://api.voucher-staging.allride.io/partner/v1/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Analysts"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Analysts'})
};

fetch('https://api.voucher-staging.allride.io/partner/v1/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.voucher-staging.allride.io/partner/v1/groups"

payload = { "name": "Analysts" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/groups")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Analysts\"\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/partner/v1/groups"

	payload := strings.NewReader("{\n  \"name\": \"Analysts\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Analysts'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 14070,
    "resource": "group",
    "partnerId": 1069,
    "key": null,
    "name": "Analysts",
    "description": "Read statistics.",
    "permissions": [
      "view-profile",
      "view-consumer-analytics"
    ],
    "permissionsComputed": false,
    "isSystem": false,
    "status": "active",
    "memberCount": 1,
    "createdAt": "2026-10-22T09:00:00Z",
    "updatedAt": "2026-10-22T09:00:00Z",
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/partner/v1/groups/14070",
        "type": "application/json"
      },
      "members": {
        "href": "https://api.voucher.allride.io/partner/v1/groups/14070/members",
        "type": "application/json"
      }
    }
  }
}

Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization

string

header

required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

Idempotency-Key

string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255

Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

New group.

name

string

required

Name, unique among active groups (1-80 characters).

Required string length: 1 - 80

description

string | null

Description (at most 500 characters).

Maximum string length: 500

permissions

string[]

Permissions (at most 100); you can grant only permissions you hold.

Maximum array length: 100

A permission (role) key such as view-consumer-catalog or create-consumer-redemptions. See Permissions and scopes and GET /partner/v1/permissions.

Pattern: ^[a-z][a-z0-9-]*$

memberIds

integer<uint64>[]

Membership ids to add (at most 500); not your own.

Maximum array length: 500

Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Response

Created

Single-object envelope around a Group.

data

object

required

A group of members with its permissions.

Show child attributes

Consumer API

Workspace API

Create a group

Authorizations

Headers

Body

Response