Operations 16
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
“Who are the users in my Gainsight instance?”
“Can I page through users by page number?”
Tell an agent
List users, page {pageNumber}.
Show all Gainsight users, {pageSize} per page.
Ask an LLM
“How do I add an end user to Gainsight PX, or overwrite them if they exist?”
“Can I link a new PX user to an account when creating them?”
Tell an agent
Upsert PX user {identifyId} with email {email}.
Create or update user {identifyId} on account {accountId} with role {role}.
Ask an LLM
“Where can I look up a Gainsight user by user ID?”
“What details are stored for one user?”
Tell an agent
Get user {userId}.
Show the Gainsight user record {userId}.
Ask an LLM
“Can I change a Gainsight user's license type or user type?”
“Is it possible to update a user's role and email in Gainsight?”
Tell an agent
Set license type {LicenseType} for user {userId}.
Change user {userId}'s role to {Role} and user type to {UserType}.
Ask an LLM
“Can I patch just a PX user's title or phone?”
“Can a PX user be moved to a different account?”
Tell an agent
Patch user {userId} ({identifyId}) with title {title}.
Move PX user {userId} ({identifyId}) to account {accountId}.
Ask an LLM
“Can I delete a user from Gainsight PX by user ID?”
“How is a PX user removed?”
Tell an agent destructive · confirm first
Delete user {userId}.
Remove user {userId} from Gainsight PX.
Ask an LLM
“Is there a way to deactivate a user without deleting them?”
“Can I disable a Gainsight user account?”
Tell an agent destructive · confirm first
Deactivate user {userId}.
Disable the account of user {userId}.
Ask an LLM
“Which users match a filter such as role or last seen date?”
“Does the v1 user listing support sorting and scroll paging?”
Tell an agent
Get v1 users matching {filter}.
List v1 users sorted by {sort}.
Ask an LLM
“What does the v1 endpoint require to create a user?”
“Can I set a Salesforce contact ID when creating a v1 user?”
Tell an agent
Create v1 user {identifyId} under product key {propertyKeys}.
Add v1 user {identifyId} ({propertyKeys}) with email {email} and account {accountId}.
DELETE
/v1/users/delete
Delete a user whose ID has special characters · Delete user (identifyId passed via request body)
#
Ask an LLM
“How do I delete a user whose identify ID can't go in the URL?”
“Is there a delete that takes the user ID in the request body?”
Tell an agent destructive · confirm first
Delete user {identifyId}, passing the ID in the body.
Hard-delete ({hardDelete}) body-identified user {identifyId}.
Ask an LLM
“Is a given user on the denylist?”
“Are a user's events being ignored by PX?”
Tell an agent
Check the denylist flag for user {identifyId}.
Tell me if user {identifyId} is denied.
Ask an LLM
“Can I make PX ignore all events from a test user?”
“Can I take a user off the denylist?”
Tell an agent
Set the denylist flag for user {identifyId} to {denied}.
Stop recording events from user {identifyId} by setting denied to {denied}.
PUT
/v1/users/update
Update a user whose ID has special characters · Update user (identifyId passed via request body)
#
Ask an LLM
“How do I update a user whose identify ID can't go in the URL path?”
“Is there a v1 update that takes the user ID in the body?”
Tell an agent
Update user {identifyId} (ID in body) with product key {propertyKeys}.
Change the email of body-identified user {identifyId} to {email}, key {propertyKeys}.
Ask an LLM
“What does a user's full v1 profile contain when fetched by identify ID?”
“Can I see a user's number of visits and last seen date?”
Tell an agent
Retrieve v1 user {identifyId}.
Show visits and last seen date for user {identifyId}.
Ask an LLM
“Can I overwrite a v1 user's record using the identify ID in the URL?”
“Can I update a user's title through the v1 API?”
Tell an agent
Replace v1 user {identifyId} with body ID {bodyIdentifyId} and product key {propertyKeys}.
Set v1 user {identifyId}'s title to {title} (body ID {bodyIdentifyId}, key {propertyKeys}).
Ask an LLM
“If I delete a user and they come back within 7 days, is their history revived?”
“How do I permanently delete a user so they can't be revived?”
Tell an agent destructive · confirm first
Delete v1 user {identifyId}.
Hard-delete user {identifyId} with hardDelete {hardDelete}.
Documentation
Documentation
https://support.gainsight.com/PX/API_for_Developers
Authentication
https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
Documentation
https://support.gainsight.com/PX/API_for_Developers/APIs_for_Developers/PX_API
Documentation
https://gainsightpx.docs.apiary.io/
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation
Authentication
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Generate_REST_API/Generate_REST_API_Key
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Custom_Object_API/Gainsight_Custom_Object_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_(CTA)_API_Documentation
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Timeline_API/Timeline_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Success_Plan_APIs/Success_Plan_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Data_Management_APIs/Data_Management_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_REST_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Bulk_API/Gainsight_Bulk_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Events_API/Events_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/User_Management_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/SCIM_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/API_for_Company_Team_Record
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Customer_Goals_API/Customer_Goals_APIs
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Renewal_Center_API/Renewal_Center_API
Documentation
https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-user-2-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-user-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-user-input-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-gainsight-user-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-response-entity-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-users-page-schema.json