<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Program Track Completed Content Track Completed Pages Track Completed Page Builder Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Knowledge Assistant Track Completed Multi-Language Experiences Track Completed Fall '22 Release Highlights Track Completed Spring '23 Release Highlights Track Completed Chat Track Completed Summer '23 Release Highlights Track Completed Fall '23 Release Highlights Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
Guide
Manage Users
Arrow Back
Completed
Introduction
Introduction
completed
Completed 1
Step 1
Create a User
completed
Completed 2
Step 2
Retrieve Users
completed
Completed 3
Step 3
Retrieve a User's Information
completed
Completed 4
Step 4
Update a User's Password
completed
Completed 5
Step 5
Delete a User
completed
home

Step 1: Create a User

To create a new user, you will use the Users: Create endpoint (see docs). In the request body, the required fields to create a user are:

  • id
  • firstName
  • lastName
  • emailAddress

If you want the newly created user to be able to log into the Yext platform upon creation, then you will also need to provide at least one Access Control in the acl field of the request body. An Access Control (ACL) is defined by:

  • The roleId and roleName fields, which can be found by making a request to:
  • The onType field, which represents the type of object the role is to be applied to. This value is one of:
    • ACCOUNT - if you would like the user to have the permissions associated with the selected role on the entire account
    • ENTITY - if you would like the user to have the permissions associated with the selected role on a specific entity
    • FOLDER - if you would like the user to have the permissions associated with the selected role on the entities in a specific folder
  • The on field, which represents the id of the object the role is to be applied to. For example:
    • If onType = ACCOUNT, on == account id
    • If onType = ENTITY, on is the entity id
    • If onType = FOLDER, on is the folder id
  • The accountId field, which is the id of the Yext account the user should be created under.

Now, you are ready to make your call! In this example, we are creating a user for John Doe with the built-in Account Manager role applied to the full account.

POST https://api.yextapis.com/v2/accounts/{accountId}/users?v=YYYYMMDD&api_key=API_KEY

{
	"id": "testUser",
	"firstName": "John",
	"lastName": "Doe",
	"username": "johnDoeSuperTest",
	"emailAddress": "john.doe@emails.com",
	"acl": [{
		"roleId": "20",
		"roleName": "Account Manager",
		"on": "Your account id",
		"accountId": "You account id",
		"onType": "ACCOUNT"
	}]
}

If the request is successful, you will get a 201 response containing the User id you provided.

Feedback
<% elem.innerText %>