Skip to main content
POST
Precheck an external action

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
action_type
enum<string>
required
Available options:
query_event_personnel,
unlock_event_contacts,
unlock_contact_emails,
search_exhibitor_events,
others
params
object
required
call_source
string
locale
string
trace_id
string
conversation_id
string
channel_message_id
string

Response

Precheck decision envelope

ok
boolean
required
action_type
string
required
allowed
boolean
required
should_charge
boolean
required
credits
integer
required
reason_code
enum<string>
required
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
detail
object
required