Customers and access

Grant access

View as Markdown Raw markdown in a new tab Open in ChatGPT Ask questions about this page Open in Claude Ask questions about this page

POST / v1 / access / grant

Gives a person access to a live product without an order: no payment and no invoice. For example a gift, or a purchase on another platform.

Creates the customer if needed. A customer created this way counts toward the plan limit of external customers until they buy.
The person gets an email with the access link, unless send_email is false.
It does not subscribe the person to the newsletter.
Not possible for booking, newsletter and external products.

Changes at once MCP tool grant_access

curl -X POST "https://api.tentary.com/v1/access/grant" \
  -H "Authorization: Bearer $TENTARY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "[email protected]",
  "product_id": 101,
  "first_name": "Lisa",
  "last_name": "Hahn",
  "reason": "complimentary"
}'

const response = await fetch("https://api.tentary.com/v1/access/grant", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TENTARY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "[email protected]",
    "product_id": 101,
    "first_name": "Lisa",
    "last_name": "Hahn",
    "reason": "complimentary"
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    "https://api.tentary.com/v1/access/grant",
    headers={"Authorization": f"Bearer {os.environ['TENTARY_API_KEY']}"},
    json={
        "email": "[email protected]",
        "product_id": 101,
        "first_name": "Lisa",
        "last_name": "Hahn",
        "reason": "complimentary",
    },
)
data = response.json()

<?php
$ch = curl_init('https://api.tentary.com/v1/access/grant');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TENTARY_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'email' => '[email protected]',
        'product_id' => 101,
        'first_name' => 'Lisa',
        'last_name' => 'Hahn',
        'reason' => 'complimentary',
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 · Response

{
  "status": "created",
  "message": "Access granted.",
  "grant_id": 2,
  "customer": {
    "id": 405,
    "email": "[email protected]",
    "created": true,
    "reactivated": false
  },
  "product": {
    "id": 101,
    "name": "Yoga Basics E-Book",
    "variant_id": null
  },
  "access_email": "queued"
}

Authorization

Authorization string header required

Bearer tnt_… · A personal API key (tnt_...). Create it in the Tentary app on the page AI & API. Introduction

Body application/json

email string required

The customer's e-mail address.

min length 3 max length 255
product_id integer required

The id from list_products.

min 1
variant_id integer

Needed for a product with variants (get_product shows them).

min 1
first_name string

For a new customer.

max length 100
last_name string

For a new customer.

max length 100
reason string

Shown in the app. Default manual.

Allowed values: manualcomplimentarypurchased_elsewhere
send_email boolean

Send the access e-mail (default true).

Response

Fields of the answer with status 200. Errors always have the same format, see Errors.

status string

exists and purchased: the customer had access already, so no grant was added. A deactivated customer is still reactivated: see customer.reactivated.

Allowed values: createdreactivatedexistspurchased
message string

What happened, in words for the seller.
grant_id integer can be null

The ID of the access grant.
customer object

The customer.
Show 4 fields Hide fields
- id integer
  
  The ID.
- email string
  
  E-mail address.
- created boolean
  
  true = a new customer.
- reactivated boolean
  
  true = a deactivated customer was reactivated.
product object

The product.
Show 3 fields Hide fields
- id integer
  
  The ID.
- name string
  
  The name.
- variant_id integer can be null
  
  The variant ID, if any.
access_email string

queued = the e-mail with the access link goes out in the next minutes. suppressed = the address bounced before.

Allowed values: queuedsuppressednot_sent