Create account invitation

curl --request POST \
  --url https://api.veryfront.com/accounts/{account_id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "admin"
}
'

import requests

url = "https://api.veryfront.com/accounts/{account_id}/invitations"

payload = {
    "email": "[email protected]",
    "role": "admin"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '[email protected]', role: 'admin'})
};

fetch('https://api.veryfront.com/accounts/{account_id}/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.veryfront.com/accounts/{account_id}/invitations",
  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([
    'email' => '[email protected]',
    'role' => 'admin'
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.veryfront.com/accounts/{account_id}/invitations"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\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))

}

HttpResponse<String> response = Unirest.post("https://api.veryfront.com/accounts/{account_id}/invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.veryfront.com/accounts/{account_id}/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 = "{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "role": "owner",
  "status": "pending",
  "expires_at": "<string>",
  "invited_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accepted_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resolved_at": "<string>",
  "created_at": "<string>",
  "token": "<string>"
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

POST

accounts

{account_id}

invitations

Create account invitation

curl --request POST \
  --url https://api.veryfront.com/accounts/{account_id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "admin"
}
'

import requests

url = "https://api.veryfront.com/accounts/{account_id}/invitations"

payload = {
    "email": "[email protected]",
    "role": "admin"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '[email protected]', role: 'admin'})
};

fetch('https://api.veryfront.com/accounts/{account_id}/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.veryfront.com/accounts/{account_id}/invitations",
  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([
    'email' => '[email protected]',
    'role' => 'admin'
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.veryfront.com/accounts/{account_id}/invitations"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\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))

}

HttpResponse<String> response = Unirest.post("https://api.veryfront.com/accounts/{account_id}/invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.veryfront.com/accounts/{account_id}/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 = "{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "role": "owner",
  "status": "pending",
  "expires_at": "<string>",
  "invited_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accepted_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resolved_at": "<string>",
  "created_at": "<string>",
  "token": "<string>"
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

account_id

string<uuid>

required

Body

application/json

string<email>

required

Invitation recipient email. Only one pending invitation is allowed per email; another creation returns 409 until it is revoked or expires. Creation does not send email or reserve a seat; tier and seat capacity are checked when a new member accepts.

Maximum string length: 254

role

enum<string>

default:admin

Invited administrator or member role. Defaults to administrator for existing clients.

Available options:

admin,

member

Response

Invitation created; the token is returned only here

string<uuid>

required

account_id

string<uuid>

required

string

required

role

enum<string>

required

Available options:

owner,

admin,

member

status

enum<string>

required

Pending invitations are reported as expired after expires_at.

Available options:

pending,

accepted,

revoked,

expired

expires_at

string

required

invited_by_user_id

string<uuid> | null

required

accepted_by_user_id

string<uuid> | null

required

resolved_at

string | null

required

created_at

string

required

token

string

required

Raw acceptance token. Returned exactly once; the server stores only its hash.

Get started

APIs

REST API

GraphQL API

MCP API

Create account invitation

Authorizations

Path Parameters

Body

Response