Send a user invitation email

POST/public/v1/core/user_profiles/invite

Bearer token

Invite people into Qashio so they can be issued cards.

Sends a Qashio onboarding invitation email to each address supplied. Invitees are created as end users; this endpoint cannot create administrators. Once an invitee completes onboarding they have a user profile, which is what POST /public/v1/core/cards needs in order to issue them a card.

Invitations may be processed immediately or queued. When processed immediately the response carries a summary of which addresses succeeded and which failed; when queued, no summary is returned and the invitations are sent shortly afterwards. Check data.summary rather than the status code to confirm delivery.

Already-invited addresses are reported as failures in the summary rather than failing the request.

Request body

application/jsonrequired

Field	Type	Description
`end_user`	array of strings	Email addresses to invite

JSON

{ "end_user": ["jane@acme.com", "sam@acme.com"] }

Response

201 with message: "Resource created successfully." and:

Field	Type	Description
`message`	string	Human-readable outcome
`summary`	object	Present when invitations were processed immediately
`summary.success_emails.end_user[]`	array	Addresses invited successfully
`summary.failed_emails.end_user[]`	array	Addresses that could not be invited
`summary.total_processed`	object	`{ success, failed, total }`

Response schema from the OpenAPI document

Field	Type	Description
`status_code`	integer
`success`	boolean
`message`	string
`data`	object
`message`	string
`summary`	object
`failed_emails`	object
`success_emails`	object
`total_processed`	object
`meta`	object
`request_id`	string
`timestamp`	string

5 nested fields

`data.summary.failed_emails.end_user`	string[]
`data.summary.success_emails.end_user`	string[]
`data.summary.total_processed.success`	integer
`data.summary.total_processed.failed`	integer
`data.summary.total_processed.total`	integer

Errors

400 (no valid addresses, or the request was rejected), 401.

OAuth

400Bad Request
401Unauthorized - missing or invalid Bearer token

Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.

POST/public/v1/core/user_profiles/invite

curl -X POST 'https://api.qashio.com/public/v1/core/user_profiles/invite' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "end_user": [
      "jane@acme.com",
      "sam@acme.com"
    ]
  }'

const accessToken = process.env.QASHIO_ACCESS_TOKEN;

const response = await fetch('https://api.qashio.com/public/v1/core/user_profiles/invite', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: `Bearer ${accessToken}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "end_user": [
      "jane@acme.com",
      "sam@acme.com"
    ]
  }),
});

if (!response.ok) {
  throw new Error(`Qashio API ${response.status}: ${await response.text()}`);
}

const { data, meta } = await response.json();
console.log(meta.request_id, data);

import https from 'node:https';

const url = new URL('https://api.qashio.com/public/v1/core/user_profiles/invite');

const payload = await new Promise((resolve, reject) => {
  const req = https.request(
    url,
    {
      method: 'POST',
      headers: {
      Accept: 'application/json',
      Authorization: `Bearer ${process.env.QASHIO_ACCESS_TOKEN}`,
        'Content-Type': 'application/json',
      },
    },
    (res) => {
      let raw = '';
      res.on('data', (chunk) => (raw += chunk));
      res.on('end', () => resolve(JSON.parse(raw)));
    },
  );
  req.on('error', reject);
  req.write(JSON.stringify({
    "end_user": [
      "jane@acme.com",
      "sam@acme.com"
    ]
  }));
  req.end();
});

console.log(payload.data);

import os
import requests

url = "https://api.qashio.com/public/v1/core/user_profiles/invite"
headers = {
    "Accept": "application/json",
    "Authorization": f"Bearer {os.environ['QASHIO_ACCESS_TOKEN']}",
}

payload = {
  "end_user": [
    "jane@acme.com",
    "sam@acme.com"
  ]
}

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

body = response.json()
print(body["meta"]["request_id"], body["data"])

<?php

$ch = curl_init('https://api.qashio.com/public/v1/core/user_profiles/invite');

curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
      'Accept: application/json',
      'Authorization: Bearer ' . getenv('QASHIO_ACCESS_TOKEN'),
      'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
  'end_user' => [
    'jane@acme.com',
    'sam@acme.com'
  ]
]),
]);

$response = curl_exec($ch);
curl_close($ch);

$body = json_decode($response, true);
print_r($body['data']);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	payload := []byte(`{
  "end_user": [
    "jane@acme.com",
    "sam@acme.com"
  ]
}`)

	req, _ := http.NewRequest("POST", "https://api.qashio.com/public/v1/core/user_profiles/invite", bytes.NewBuffer(payload))
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("QASHIO_ACCESS_TOKEN"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out map[string]any
	json.NewDecoder(res.Body).Decode(&out)
	fmt.Println(out["data"])
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.qashio.com/public/v1/core/user_profiles/invite')
request = Net::HTTP::Post.new(uri)
request['Accept'] = 'application/json'
request['Authorization'] = "Bearer #{ENV.fetch('QASHIO_ACCESS_TOKEN')}"
request['Content-Type'] = 'application/json'
request.body = "{\n  \"end_user\": [\n    \"jane@acme.com\",\n    \"sam@acme.com\"\n  ]\n}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

body = JSON.parse(response.body)
puts body['data']

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class QashioExample {
  public static void main(String[] args) throws Exception {
    String payload = """
      {
        "end_user": [
          "jane@acme.com",
          "sam@acme.com"
        ]
      }
      """;

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://api.qashio.com/public/v1/core/user_profiles/invite"))
        .header("Accept", "application/json")
        .header("Authorization", "Bearer " + System.getenv("QASHIO_ACCESS_TOKEN"))
        .header("Content-Type", "application/json")
        .method("POST", HttpRequest.BodyPublishers.ofString(payload))
        .build();

    HttpResponse<String> response = HttpClient.newHttpClient()
        .send(request, HttpResponse.BodyHandlers.ofString());

    System.out.println(response.body());
  }
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.qashio.com/public/v1/core/user_profiles/invite");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", $"Bearer {Environment.GetEnvironmentVariable("QASHIO_ACCESS_TOKEN")}");

var payload = @"{
  ""end_user"": [
    ""jane@acme.com"",
    ""sam@acme.com""
  ]
}";
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

Console.WriteLine(await response.Content.ReadAsStringAsync());

import Foundation

var request = URLRequest(url: URL(string: "https://api.qashio.com/public/v1/core/user_profiles/invite")!)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Accept")
let token = ProcessInfo.processInfo.environment["QASHIO_ACCESS_TOKEN"]!
request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{
  "end_user": [
    "jane@acme.com",
    "sam@acme.com"
  ]
}
""".data(using: .utf8)

let (data, _) = try await URLSession.shared.data(for: request)
print(String(data: data, encoding: .utf8)!)

Response

{
  "status_code": 201,
  "success": true,
  "message": "Resource created successfully.",
  "data": {
    "message": "User invited successfully",
    "summary": {
      "failed_emails": {
        "end_user": []
      },
      "success_emails": {
        "end_user": []
      },
      "total_processed": {
        "success": 1,
        "failed": 0,
        "total": 1
      }
    }
  },
  "meta": {
    "request_id": "3adb2d16090c7b3bdbde3b326a814b30",
    "timestamp": "2026-09-09T10:07:52.143Z"
  }
}

{
  "status_code": 401,
  "success": false,
  "message": "Missing Bearer token",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing Bearer token"
  },
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Missing Bearer token",
      "field": "authorization"
    }
  ],
  "meta": {
    "request_id": "3adb2d16090c7b3bdbde3b326a814b30",
    "timestamp": "2026-09-09T10:07:52.143Z"
  }
}

{
  "status_code": 401,
  "success": false,
  "message": "Missing Bearer token",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing Bearer token"
  },
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Missing Bearer token",
      "field": "authorization"
    }
  ],
  "meta": {
    "request_id": "3adb2d16090c7b3bdbde3b326a814b30",
    "timestamp": "2026-09-09T10:07:52.143Z"
  }
}