Boomerang Agency icon

Boomerang Agency

Agency-level Boomerang (GoHighLevel) operations — create sub-accounts, apply snapshots, invite users. Reuses the Boomerang Agency OAuth2 credential without doing a location-token exchange.

Actions16

User → Create / Invite

AI-generated

Summary

Creates a new user (or sub-account user) within the GoHighLevel agency and optionally sends them an invite email.

Inputs

  • firstName (required) — User's first name. GHL validates the charset: letters, numbers, accents, spaces, and basic punctuation only; parentheses are rejected.
  • lastName (required) — User's last name. Same validation rules apply as firstName.
  • email (required) — Email address the user logs in with. Must be unique across the agency.
  • phone — Phone number in E.164 format. Optional — leave blank to omit.
  • type (required) — User type: 'account' (sub-account scoped to locations) or 'agency' (agency-level).
  • role — User role: 'admin' or 'user'. Defaults to 'user'.
  • locationIds — Sub-accounts this user can access. Required when User Type is 'account'.
  • sendInvite — Whether to omit the password so GHL emails an invite. Defaults to true. Must be false if a password is provided.
  • password — Minimum 12 characters with uppercase, lowercase, number, and special character. Only visible when 'Send invitation' is off.
  • additionalFields — Optional granular settings: Company ID override, permissions (feature flags), platform language, profile photo URL, scopes, and scopes assigned to only.

Output shape

The raw JSON response from GHL containing the created user object.

The returned object includes the user ID and other metadata populated by GHL.

Examples

Example 1: Create a standard sub-account user with an invite email.

Set type to 'account', provide locationIds, set sendInvite to true, and leave password blank.

Example 2: Provision a user with a specific password without sending an invite.

Set sendInvite to false and provide a compliant password in the password field.

Links

Discussion