POST
Ticket.EncryptedFields
Return org-defined encrypted custom fields for a ticket customer or a customer id (customer-tickets encrypted fields). Values show as •••••••• until Ticket.UnlockEncrypted succeeds (or enc password is not configured).
Permissions
- User must be logged in with a valid bearer token.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Runs the Ticket.EncryptedFields function and returns JSON.
Push Service
No push is sent because this function only reads data or returns helper information.
Automation
No automation is run for this function.
Special Instructions
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- Provide ticket_id OR cust_id (anyOf) — one is required.
- With ticket_id, values come from the ticket customer_extra_fields; with cust_id, from contactus.extra_fields.
- Call Ticket.UnlockEncrypted first when enc_pwd_configured=1 and you need plain values.
- If password is not configured, fields return unlocked (plain) automatically.
- Field defs come from org user_detail.extra_fields where encrypted_data=1.
Required Parameters
No body parameters are required for this function.
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
ticket_idpost | int | 900 | Ticket id (loads that ticket's customer extras). Aliases: id, data_id, t_id. Required if cust_id omitted. |
cust_idpost | int | 100 | Customer id. Alias: customer_id. Required if ticket_id omitted. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Ticket.EncryptedFields",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"ticket_id": "900"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Ticket.EncryptedFields",
"url_domain": "https:\/\/{domain}\/app\/Ticket.EncryptedFields"
}Endpoint
POST /app/Ticket.EncryptedFields
POST https://{user}.bull36.com/app/Ticket.EncryptedFields
POST https://{domain}/app/Ticket.EncryptedFieldsSample Output
{
"success": 1,
"enc_pwd_configured": 1,
"enc_pwd_unlocked": 0,
"fields": [
{
"name": "id_number",
"label": "ID number",
"value": "••••••••",
"has_value": 1,
"locked": 1
}
]
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ ticket_id: '900' });
const res = await fetch('/app/Ticket.EncryptedFields', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());Error Example
{
"success": 0,
"message": "Missing required parameter: ticket_id or cust_id"
}