Create Halo Client
The Create Halo Client action creates a new client/company in Halo PSA. Supply the client name, website, and any additional details to create the record.
This building-block API call action creates one client record, then retrieves its complete saved details and Custom Field values. Learn more about workflow actions and API call actions.
When to Use This Action
Use this action when:
- You need to create a new client in Halo after a domain or sender lookup fails
- You are onboarding a new customer through an automation
- You want precise control over client properties at creation time
Don't use this action for:
- Looking up an existing client by email domain: Use Find Halo User and Client by Email first to avoid creating duplicates.
- Searching clients by arbitrary criteria: Use Query Halo Clients to find existing clients.
When the Create Halo Ticket from Email workflow action falls back to the catch-all default client, you can use this action afterward to create a properly named client and then use Create Halo User to create the sender as a user under it.
Configuration
Connection
| Field | Description |
|---|---|
| Halo Connection | Select the Halo connection to use for this action. |
Client Information
| Field | Description |
|---|---|
| Client Name | The client/company name. Supports text expressions. |
| Website / Domain | The client's website or primary email domain (e.g., acme.com). This value is used by Find Halo User and Client by Email to match future senders to this client. Supports text expressions. |
| Trading Name | The client's trading name, if different from the client name. Supports text expressions. |
| Notes | Free-form notes to store on the client record. Supports text expressions. |
Custom Fields
| Field | Description |
|---|---|
| Custom Fields | Select client custom fields and set their values. Text values support text expressions, including text nested inside array values. The action checks current Halo metadata, requires fields Halo explicitly marks as mandatory, and rejects known read-only or unsupported fields. Unknown positive field IDs entered dynamically are preserved. Boolean false, zero, arrays, empty strings, and null values retain their exact value. |
Error Handling
| Field | Description |
|---|---|
| Error Handling | Action to take if client creation fails. |
| Option | Behavior |
|---|---|
| Exception | Halt processing and report the error |
| Bounce | Return the email/item to the sender |
| Continue | Continue to the next action |
| Stop | In Email Processing, stop this rule but allow other rules to process |
| Stop All | Stop all processing for this message |
Returned Variables
When you configure Store the results in Variable, the result is the complete saved client object. MSPintegrations combines the full client detail response with saved Custom Field values for that exact client. Access properties using dot syntax. If creation or refresh fails, the stored result is null; an HTTP error body is never stored as the client.
Example usage: {{custom.myVariable.id}}
| Variable | Type | Description |
|---|---|---|
.id | number | The created client ID |
.name | string | The client name |
.toplevel_id | number | The top-level organization ID the client belongs to |
.website | string | The client's website/domain |
.trading_name | string | The client's saved trading name |
.notes | string | The client's saved notes |
.customfields | array | Custom fields returned on the created client |
.customfields[].id | number | The Halo custom field ID |
.customfields[].value | mixed | The custom field value |
FAQs
What fields are required?
You must provide a Halo Connection and a Client Name. The Website / Domain is strongly recommended so that future email lookups can match this client by sender domain.
How do I avoid creating duplicate clients?
Run Find Halo User and Client by Email first and only run this action when the determined client is the catch-all default and you want to replace the default with a new, accurately-named client.
Does this action create sites or users?
No. It creates only the client record. Use Create Halo User to create users. Sites are managed directly in Halo.
Related Actions
- Find Halo User and Client by Email: Determine a client before creating a new one
- Create Halo Ticket from Email: Automated email-to-ticket flow that uses the catch-all default client when no client can be determined
- Create Halo User: Create users that belong to the new client
- Query Halo Clients: Search existing clients before creating a duplicate