Vendasta Users API
The Users API from Vendasta — 5 operation(s) for users.
Operations 14
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Can I add a new user account under my partner through the API?”
“What fields are mandatory when creating a new user?”
Tell an agent
Create a new user with the email and partner I give you.
Add a user record for {data}.
OPTIONS
/users
Check allowed HTTP methods on the users collection · List valid HTTP verbs for /users
#
Ask an LLM
“Which HTTP verbs does the users collection endpoint accept for CORS preflight?”
“What does a browser preflight on the users list return?”
Tell an agent
Send a CORS preflight request to the users collection.
Show the allowed methods and headers for the users list endpoint.
Ask an LLM
“Which users belong to my partner account in Vendasta?”
“Can I find a user by their email address or a search term?”
Tell an agent
List all users for partner {partner}.
Find the user whose email is {email}.
Ask an LLM
“How can I look up a single user's profile by ID?”
“What information comes back for one specific user?”
Tell an agent
Get user {id}.
Show me the details stored for user {id}.
OPTIONS
/users/{id}
Check allowed HTTP methods on a single user · List valid HTTP verbs for /users/{id}
#
Ask an LLM
“Which HTTP verbs are permitted on an individual user resource?”
“What does a CORS preflight on one user's endpoint return?”
Tell an agent
Run a CORS preflight against user {id}.
Show which methods the single-user endpoint allows for {id}.
Ask an LLM
“Can I change just a few fields on an existing user without resending everything?”
“What happens to user fields I leave out of an update?”
Tell an agent
Update user {id} with {data}.
Edit the profile of user {id}.
Ask an LLM
“Can I permanently delete a user and remove their personal data?”
“Once a user is deleted, can their ID be reused later?”
Tell an agent destructive · confirm first
Delete user {id}.
Remove user {id} and wipe their personal data.
OPTIONS
/users/{id}/relationships/businessLocations
Check allowed methods on user-location links · List valid HTTP verbs for /users/{id}/relationships/businessLocations
#
Ask an LLM
“Which HTTP verbs does the user-to-location relationship endpoint support for CORS?”
“What does a preflight on a user's business-location links return?”
Tell an agent
Send a CORS preflight to the location relationships of user {id}.
Show the allowed methods for user {id}'s location-link endpoint.
POST
/users/{id}/relationships/businessLocations
Grant a user access to more locations · Associate user with location
#
Ask an LLM
“Can I give a user access to additional business locations while keeping their current ones?”
“What happens if I grant a user a location they already have access to?”
Tell an agent
Add locations {data} to user {id}'s existing access.
Associate user {id} with these extra business locations: {data}.
GET
/users/{id}/relationships/businessLocations
List a user's business locations · Get user locations
#
Ask an LLM
“Which business locations does a given user have access to?”
“Can I see every location a user is associated with?”
Tell an agent
List the business locations user {id} can access.
Show which locations are linked to user {id}.
PATCH
/users/{id}/relationships/businessLocations
Replace a user's location access · Replace user location access
#
Ask an LLM
“Can I overwrite a user's location access so they only see the locations I list?”
“Is there a way to reset which locations a user can reach in one call?”
Tell an agent
Set user {id}'s location access to exactly {data}.
Replace all of user {id}'s business locations with {data}.
DELETE
/users/{id}/relationships/businessLocations
Revoke a user's access to locations · Dissociate user from location
#
Ask an LLM
“Can I remove a user's access to specific business locations?”
“What if I revoke a location the user never had access to?”
Tell an agent destructive · confirm first
Remove user {id}'s access to locations {data}.
Dissociate user {id} from these business locations: {data}.
Ask an LLM
“Can I read the custom field values set on a user?”
“Where do I find the extra partner-defined attributes stored on a user?”
Tell an agent
Get the custom fields for user {id}.
Show custom field values recorded on user {id}.
Ask an LLM
“Can I trigger a welcome email to a user who was already created?”
“How do I resend the onboarding welcome message to an existing user?”
Tell an agent
Send the welcome email to user {id}.
Email user {id} their welcome message now.