Users

Update User

put/api/v1.0/users/{id}

Path parameters

idstring required

The ID for the user

Request body

created_atnumber

The date/time the User was created at represented as an integer

emailstring

The email of the User

full_namestring

The name of the User

has_admin_privilegesboolean

A boolean field representing whether the User can access the Admin Console or not

idstring

The ID of the User

passwordstring

The password of the User (auto-generated if left blank)

phone_numberstring

The phone number of the User

profile_image_urlstring

A URL pointing to the Users profile image

receive_emailsboolean

A boolean field representing if the User receives emails from Wingmate or not

receives_smsboolean

A boolean field so that they receive SMS for your campaign (default is True)

tagstring

A tag that other uses can use to mention the User in Comments and Reminders (this is automatically generated if left blank)

time_zonestring

The time zone for the Users location

titlestring

The work title of the User

type'Worker' | 'Salesperson' | 'Manager'

The type of User you wish to create | OneOf(Manager, Salesperson, Worker)

{"stackTrail":"components:schemas:User:properties:uuid","oasType":"schema","type":"unknown","description":"A unique identifier the User can use to log in with (generated from the phone number if left blank)"}

Response

Success

Changes

No recorded changes to this endpoint across all 1 revision of this API.