Struct CreateUserDto 

pub struct CreateUserDto {

    pub company_id: String,
    pub email: String,
    pub password: String,
    pub phone: Option<String>,
    pub type_: String,
    pub role: String,
    pub location_ids: Vec<String>,
    pub permissions: Option<PermissionsDto>,
    pub scopes: Vec<String>,
    pub scopes_assigned_to_only: Vec<String>,
    pub profile_photo: Option<String>,
    pub twilio_phone: Option<Value>,
    pub platform_language: Option<String>,
    pub first_name: String,
    pub last_name: String,
}

Available on crate feature users only.

CreateUserDto from the GoHighLevel OpenAPI spec.

Fields

company_id: String

Company/Agency ID to associate the user with Required by the API.

email: String

Email address of the user (used for login) Required by the API.

password: String

Password for the user account. All passwords will be required to meet the following criteria: - Minimum 12 characters - At least one uppercase letter (A–Z) - At least one lowercase letter (a–z) - At least one number (0–9) - At least one special character (e.g., !, @, #, $) Required by the API.

phone: Option<String>

Phone number of the user in E.164 format

type_: String

User account type (account for sub-account users, agency for agency-level users) Required by the API.

role: String

User role within the account (admin or user) Required by the API.

location_ids: Vec<String>

List of location IDs to assign to the user Required by the API.

permissions: Option<PermissionsDto>

User permissions controlling access to various features

scopes: Vec<String>

Scopes allowed for users. Only scopes that have been passed will be enabled. Note:- If passed empty all the scopes will be get disabled Allowed values: campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write.

scopes_assigned_to_only: Vec<String>

Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled Allowed values: campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write.

profile_photo: Option<String>

URL of the user profile photo

twilio_phone: Option<Value>

Per-location inbound Twilio number in E.164 format, keyed by location id (Call and Voicemail Inbound Number for direct Twilio, not LC Phone). Replacement semantics: if you send twilioPhone in the request body, the stored map is replaced entirely with this object (not merged). Any location id omitted from the object is removed from the saved map. Omit the twilioPhone property entirely to leave existing numbers unchanged. Send an empty object {} to clear all per-location numbers. To clear a single location only, set that location id to an empty string “”.

platform_language: Option<String>

Platform language preference for the user Allowed values: en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi.

first_name: String

First name of the user Required by the API.

last_name: String

Last name of the user Required by the API.

Trait Implementations

impl Clone for CreateUserDto

fn clone(&self) -> CreateUserDto

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateUserDto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateUserDto

fn default() -> CreateUserDto

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateUserDto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateUserDto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.