nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

API endpoint to update display name

BobRoss

Hello,

I'm working on a process to update a user's name values via the API for our name change process. I've noticed the Display Name field does not update after calling the Edit Users endpoint. I'm not seeing any other endpoints that mention how to update the Display Name. Has anyone else ran into this in the past and found a solution?

Thanks,

Bobby

Find more posts tagged with

API

REST API

Accepted answers

BobRoss

And I believe I just found the answer. I added user[short_name] to the API request and the Display Name is now updated.

Is this reflected in the documentation anywhere? If not I think it'd be useful to add to it for others.

All comments

BobRoss

And I believe I just found the answer. I added user[short_name] to the API request and the Display Name is now updated.

Is this reflected in the documentation anywhere? If not I think it'd be useful to add to it for others.

Chris

Hi @BobRoss,

The Users API Documentation has this documented in a sufficient way, at least in my opinion.

-Chris

BobRoss

Hello @Chris ,

In the link you provided I see this in the Edit User section:

user[short_name]

string

User's name as it will be displayed in discussions, messages, and comments.

Is this the part you are referencing?

When comparing the fields being sent with the API and what fields are displayed when looking at a users profile, the API references user[short_name] while the Canvas UI references Display Name. I only spent about 15-20 minutes to figure this out so not a huge deal, but seems like something that would be beneficial for others in the future.

Thanks for the response!

Bobby

Unanswered Questions

Discrepancy between Canvas UI and Server Logs (500/503 Errors)
Hi everyone, I am seeking some insight into how Canvas LMS handles HTTP errors and how they are reflected in the logs versus the user interface. We are currently observing the following behavior in our environment: Log-only errors: We are seeing 500 (Internal Server Error) and 503 (Service Unavailable) errors recorded in…
LTI Variable substitution for Term SIS ID?
I looked through the LTI Variable Substitutions documentation and while there are variable substitutions available for Canvas.term.name and Canvas.term.id (which is the Canvas incremented ID like "104"), I was surprised to see there was no option for Canvas.term.sisSourceId I tried testing other possible variants that may…
Learning Mastery Gradebook: assign_outcome_order API Returns Success But Doesn't Persist Column Order
Summary:The Learning Mastery Gradebook allows drag-and-drop reordering of outcome columns, and this triggers a call to /api/v1/courses/:course_id/assign_outcome_order. The API returns 204 No Content (success), but the column order does not persist after page refresh. Steps to Reproduce: Open Learning Mastery Gradebook for…
Finding the LTIv1.3 IDs for Members of a Course
I'm building a tool for my institution that imports grades from another LTI tool into Canvas so instructors can automate late assignment policies not otherwise supported by Canvas. I'm trying to use the LTIv1.3 ID which is readily available on the LTI-side as a link to the student record on Canvas, but I can't find the ID…
Canvas Media Question
How can one track Canvas Media use without having the reports available from Canvas Studio? Checking API endpoints and the Data 2 schema, there do not seem to be dedicated Canvas Media endpoints. Am I missing some? A method I've considered is using the body field of the wiki_pages table, as this contains the html code of…