PATCH/desk/api/v2/users/{id}.json
Update user.
Path Params
- Name
id- Type
- integer
- required
- Description
Body Params
User is an agent within Teamwork Desk
- Name
autoFollowOnCC- Type
- boolean
- Description
- AutoFollowOnCC specifies whether the user should be added as a follower when they are CCed on a ticket.
- Name
avatarURL- Type
- string
- Description
- The Absolute URL to the user's avatar (read-only)
- Name
createdAt- Type
- string
- Description
- CreatedAt is a read-only date marking the creation time.
- Name
createdBy- Type
- object
- Name
deletedAt- Type
- string
- Description
- DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
- Name
deletedBy- Type
- object
- Name
editMethod- Type
- string
- Description
- The default input method for editing tickets. Options are html and markdown.
- Name
email- Type
- string
- Name
filter_args- Type
- object
- Description
- RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
- Name
firstName- Type
- string
- Name
id- Type
- integer
- Name
isAppOwner- Type
- boolean
- Description
- Specifies whether this user is the owner of the installation
- Name
isPartTime- Type
- boolean
- Description
- Part time users are limited to answering 10 tickets per month, but have no restrictions on viewing tickets
- Name
lastName- Type
- string
- Name
ldKey- Type
- string
- Name
onboarding- Type
- object
- Name
projectsCompanyId- Type
- integer
- Name
reviewer- Type
- boolean
- Description
- Reviewers are agents who should be asked to review pending tickets from users in training.
- Name
role- Type
- string
- Description
- Role specifies whether the user is an admin or agent. Admins can view and edit all sections in desk. (Deprecation coming soon)
- Name
sendPushNotifications- Type
- boolean
- Description
- Specifies whether push notifications should be sent to the mobile device(s) registered
- Name
sendWebNotifications- Type
- boolean
- Description
- When enabled browser notifications will be sent to the user regarding ticket activity they are subscribed to.
- Name
state- Type
- string
- Description
- State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
- Name
ticketReplyRedirect- Type
- string
- Description
- Specifies where the agent should be redirected to after answering a ticket. Valid options are "Stay", "Next", or "Inbox". When "Stay" the user will remain on the current ticket, "Next" redirects to the next ticket in the current queue, and "Inbox" will redirect to the ticket list within the current inbox.
- Name
timeFormatId- Type
- integer
- Description
- Fields populated from the PM database.
- Name
timezoneId- Type
- integer
- Name
trainingWheelsEnrollment- Type
- object
- Name
updatedAt- Type
- string
- Description
- UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
- Name
updatedBy- Type
- object
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
UserAPIBody handles request/response for a single user
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
200 OK
UserAPIBody
{ "included": { "inboxes": [ { "autoReplyEnabled": true, "autoReplyFromUserId": 0, "autoReplyMessage": "string", "autoReplySubject": "string", "createdAt": "2024-07-26T20:26:10.533Z", "createdBy": { "delete": true, "id": 0, "meta": {}, "type": 0 }, "deletedAt": "2024-07-26T20:26:10.533Z", "deletedBy": { "delete": true,