Actions

Precheck an external action

Evaluate whether a supported external action can run and what it is expected to cost, without executing the action or charging credits.

Use precheck immediately before event-access, Visitor-access, contact-unlock, and other action-specific workflows. Inspect allowed, should_charge, credits, and reason_code to decide whether to continue, ask the user for confirmation, or explain why the action is unavailable.

Precheck is advisory and read-only: it does not reserve credits, create a task, or lock the target state. Send the same action type and identifiers to the execution endpoint promptly, and still handle state or balance changes returned by that endpoint.

POST

external

actions

precheck

Precheck an external action

curl --request POST \
  --url https://platform.lensmor.com/external/actions/precheck \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action_type": "query_event_personnel",
  "call_source": "api",
  "params": {
    "event_id": "26855"
  }
}
'

import requests

url = "https://platform.lensmor.com/external/actions/precheck"

payload = {
    "action_type": "query_event_personnel",
    "call_source": "api",
    "params": { "event_id": "26855" }
}
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({
    action_type: 'query_event_personnel',
    call_source: 'api',
    params: {event_id: '26855'}
  })
};

fetch('https://platform.lensmor.com/external/actions/precheck', 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://platform.lensmor.com/external/actions/precheck",
  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([
    'action_type' => 'query_event_personnel',
    'call_source' => 'api',
    'params' => [
        'event_id' => '26855'
    ]
  ]),
  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://platform.lensmor.com/external/actions/precheck"

	payload := strings.NewReader("{\n  \"action_type\": \"query_event_personnel\",\n  \"call_source\": \"api\",\n  \"params\": {\n    \"event_id\": \"26855\"\n  }\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://platform.lensmor.com/external/actions/precheck")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action_type\": \"query_event_personnel\",\n  \"call_source\": \"api\",\n  \"params\": {\n    \"event_id\": \"26855\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.lensmor.com/external/actions/precheck")

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  \"action_type\": \"query_event_personnel\",\n  \"call_source\": \"api\",\n  \"params\": {\n    \"event_id\": \"26855\"\n  }\n}"

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

{
  "ok": true,
  "action_type": "query_event_personnel",
  "allowed": true,
  "should_charge": false,
  "credits": 0,
  "reason_code": "ok",
  "biz_code": "",
  "detail": {
    "event_id": "26855",
    "access_mode": "preview",
    "preview_limit": 50,
    "unlock_action_type": "unlock_event_contacts",
    "unlock_credits": 2000
  }
}

{
  "code": 400,
  "message": "Invalid request",
  "errorKey": "INVALID_REQUEST",
  "traceId": "2be6d7f4-3b2d-4d11-8e2d-7a2e4c3e9a10"
}

{
  "code": 401,
  "message": "Invalid API key",
  "errorKey": "INVALID_API_KEY",
  "traceId": "2be6d7f4-3b2d-4d11-8e2d-7a2e4c3e9a10"
}

{
  "code": 429,
  "message": "Rate limit exceeded",
  "errorKey": "RATE_LIMIT_EXCEEDED",
  "traceId": "2be6d7f4-3b2d-4d11-8e2d-7a2e4c3e9a10"
}

Authorizations

Authorization

string

header

required

Send the full Business API key from Settings -> API Keys, for example Authorization: Bearer sk_your_api_key.

Body

application/json

Read-only action eligibility and expected-credit evaluation request.

action_type

string

required

Action to evaluate. The listed examples are handled explicitly. Other 1–100 character strings are accepted and return allowed: false with reason_code: unsupported_action.

Required string length: 1 - 100

Examples:

"query_event_personnel"

"unlock_event_contacts"

"unlock_event_visitors"

"unlock_event_full_access"

"unlock_contact_emails"

"unlock_contact_phones"

"search_exhibitor_events"

"search_personnel_events_by_name"

"integration_status"

"integration_export_contacts"

"integration_export_exhibitors"

"others"

params

object

required

Action-specific identifiers and inputs, such as an event_id.

Example:

{ "event_id": "26855" }

call_source

string

Caller source label, typically api or agent.

Required string length: 1 - 100

Example:

"api"

locale

string

Optional locale used for localized guidance or messages.

Required string length: 1 - 20

Example:

"en-US"

trace_id

string

Optional caller-provided trace identifier for support correlation.

Required string length: 1 - 200

Example:

"trace_123"

conversation_id

string

Optional conversation identifier for agent workflows.

Required string length: 1 - 200

Example:

"conversation_123"

channel_message_id

string

Optional channel message identifier for agent workflows.

Required string length: 1 - 200

Example:

"message_123"

Response

Precheck decision envelope

Action eligibility, expected charging, reason, and action-specific detail.

boolean

required

Whether the precheck itself completed successfully.

action_type

string

required

Action evaluated by the precheck.

allowed

boolean

required

Whether the action is currently allowed to proceed.

should_charge

boolean

required

Whether executing the action is expected to consume credits.

credits

integer

required

Credits expected for the action under the current state.

reason_code

enum<string>

required

Stable reason explaining the eligibility and charging decision.

Available options:

ok,

already_unlocked,

unlock_in_progress,

state_conflict,

insufficient_balance,

no_contacts_available,

exceed_max_unlock_limit,

invalid_subject,

unsupported_action,

not_found,

forbidden,

system_error

biz_code

string

required

Business code associated with the precheck decision.

detail

object

required

Action-specific eligibility, cost, or state detail.

Precheck an external action

curl --request POST \
  --url https://platform.lensmor.com/external/actions/precheck \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action_type": "query_event_personnel",
  "call_source": "api",
  "params": {
    "event_id": "26855"
  }
}
'

import requests

url = "https://platform.lensmor.com/external/actions/precheck"

payload = {
    "action_type": "query_event_personnel",
    "call_source": "api",
    "params": { "event_id": "26855" }
}
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({
    action_type: 'query_event_personnel',
    call_source: 'api',
    params: {event_id: '26855'}
  })
};

fetch('https://platform.lensmor.com/external/actions/precheck', 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://platform.lensmor.com/external/actions/precheck",
  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([
    'action_type' => 'query_event_personnel',
    'call_source' => 'api',
    'params' => [
        'event_id' => '26855'
    ]
  ]),
  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://platform.lensmor.com/external/actions/precheck"

	payload := strings.NewReader("{\n  \"action_type\": \"query_event_personnel\",\n  \"call_source\": \"api\",\n  \"params\": {\n    \"event_id\": \"26855\"\n  }\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://platform.lensmor.com/external/actions/precheck")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action_type\": \"query_event_personnel\",\n  \"call_source\": \"api\",\n  \"params\": {\n    \"event_id\": \"26855\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.lensmor.com/external/actions/precheck")

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  \"action_type\": \"query_event_personnel\",\n  \"call_source\": \"api\",\n  \"params\": {\n    \"event_id\": \"26855\"\n  }\n}"

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

{
  "ok": true,
  "action_type": "query_event_personnel",
  "allowed": true,
  "should_charge": false,
  "credits": 0,
  "reason_code": "ok",
  "biz_code": "",
  "detail": {
    "event_id": "26855",
    "access_mode": "preview",
    "preview_limit": 50,
    "unlock_action_type": "unlock_event_contacts",
    "unlock_credits": 2000
  }
}

{
  "code": 400,
  "message": "Invalid request",
  "errorKey": "INVALID_REQUEST",
  "traceId": "2be6d7f4-3b2d-4d11-8e2d-7a2e4c3e9a10"
}

{
  "code": 401,
  "message": "Invalid API key",
  "errorKey": "INVALID_API_KEY",
  "traceId": "2be6d7f4-3b2d-4d11-8e2d-7a2e4c3e9a10"
}

{
  "code": 429,
  "message": "Rate limit exceeded",
  "errorKey": "RATE_LIMIT_EXCEEDED",
  "traceId": "2be6d7f4-3b2d-4d11-8e2d-7a2e4c3e9a10"
}

Credits

Actions

Events

Exhibitors

Personnel

Contacts

Profile Matching

Precheck an external action

Authorizations

Body

Response