Invite a member

POST

/api/v1/invitations

Requires the admin role.

Authorizations

bearerAuth

Request Body^required

application/json

object

invitation

object

name

required

string

email

required

string format: email

role

string

default: viewer

Allowed values: admin member viewer

Responses

201

The invitation (the invite secret is never returned)

Response body

application/json

object

string

name

string

email

string format: email

role

string

Allowed values: admin member viewer

invited_by

string | null

Name of the member who sent the invitation

created_at

string format: date-time

403

Insufficient scope, role, or credits

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

The record could not be saved

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request POST \
  --url https://app.responsehub.io/api/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "invitation": { "name": "example", "email": "hello@example.com", "role": "admin" } }'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{ \"invitation\": { \"name\": \"example\", \"email\": \"hello@example.com\", \"role\": \"admin\" } }"

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.responsehub.io/api/v1/invitations', [
  'body' => '{ "invitation": { "name": "example", "email": "hello@example.com", "role": "admin" } }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/invitations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"invitation":{"name":"example","email":"hello@example.com","role":"admin"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

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

func main() {

  url := "https://app.responsehub.io/api/v1/invitations"

  payload := strings.NewReader("{ \"invitation\": { \"name\": \"example\", \"email\": \"hello@example.com\", \"role\": \"admin\" } }")

  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(res)
  fmt.Println(string(body))

}

Request body example

Example^generated

{
  "invitation": {
    "name": "example",
    "email": "hello@example.com",
    "role": "admin"
  }
}

201example

Example^generated

{
  "id": "inv_1a2b",
  "name": "example",
  "email": "hello@example.com",
  "role": "admin",
  "invited_by": "example",
  "created_at": "2026-04-15T12:00:00Z"
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

Invite a member

Authorizations

Request Bodyrequired

Responses

201

403

422

Request Body^required