Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
OAuth 2.0 (Client Credentials) · Connector Profile
Requires generating client credentials on an API user (no password or certificate needed). SAP’s recommended method for…
Basic Auth · Connector Profile
Uses the user name and password of an API user. No app registration; access is limited to the services in the technical…
SAP Business Accelerator Hub — API Key · Connector Profile
Connects to SAP’s shared, read-only demo tenant on the Business Accelerator Hub with your Hub API key. For evaluating th…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
OAuth 2.0 (Client Credentials) · Link Account
Basic Auth · Link Account
SAP Business Accelerator Hub — API Key · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
|
No auth methods found
|
No scopes found
187 actions
Action
Description
Required scopes
List Tasks
Task can be queried from the system using optional filterorsearch query parameters. By default, the system fetches t…
Get Task
Read the Task from the system using the ID of the task. The attributes of task can be selected using $select or excluded…
Create Task
You can create a task for a user using ID or display ID of account, owner, organizer and sales organization. You can cre…
Update Task
Attributes of task can be updated by sending the updated values in the request. IF-MATCH http header is mandatory for up…
Delete Task
Task in the system can be deleted by sending a delete request.
List Appointments
Specify query parameters to return desired appointment records from the system.
Get Appointment
Query the system for a specific appointment using the appointment ID.
Create Appointment
Create a new appointment. Note creation within appointments is no longer supported. Use Hypernote APIs for managing note…
Update Appointment
Update an existing appointment. Note updates within appointments are no longer supported. Use Hypernote APIs for managin…
Delete Appointment
Delete an appointment by ID.
List Phone Calls
Specify query parameters to return desired phone records from the system.
Get Phone Call
Query the system for a specific phone record using the phone interaction id.
Create Phone Call
Send phone information to the system to create a new phone interaction.
Update Phone Call
Update phone interaction attributes in the system.
Delete Phone Call
Delete the phone interaction for the given phone interaction id.
List Emails
Query email interactions.
Get Email
Read email interaction by ID.
Create Email
Create email interaction.
Update Email
Update email interaction.
Delete Email
Delete email interaction.
List Visits
Visits can be queried using optional filterorsearch query parameters. By default, the system fetches the top 50 visi…
Get Visit
Read the visit using its ID. The attributes of visit can be selected using selectorexcludedusingexclude.
Create Visit
You can create a visit using the ID or display ID of the account or individual customer. You can create visit in the dry…
Update Visit
Attributes of visit can be updated by sending the updated values in the request. IF-MATCH http header is mandatory for u…
Delete Visit
Visit can be deleted by sending a delete request.
List Person Interactions
Specify query parameters to return in-person interactions.
Get Person Interaction
Query the system for an in-person interaction using an ID.
Create Person Interaction
Send in-person interaction information to the system to create an in-person interaction.
Update Person Interaction
Update an in-person interaction partially using an ID.
List Task Categories
Task Categories can be queried from the system by using optional filterorsearch query parameters. By default top 50…
List Appointment Categories
Query appointment categories.
List Visit Types
Visit types can be queried from the system by using optional filterorsearch query parameters. By default top 50 visi…
List Phone Call Results
Specify query parameters to return desired call result records from the system.
List Campaigns
Specify query parameters to return desired campaign records from the system.
Get Campaign
Query the system for a specific campaign using the campaign ID.
Create Campaign
Send campaign information to the system to create a new campaign entity.
Update Campaign
Update campaign attributes in the system.
Delete Campaign
Delete a campaign by ID.
List Sales Territories
Specify query parameters to return desired sales territory records from the system.
Get Sales Territory
Read a specific sales territory using the sales territory ID.
Create Sales Territory
Send sales territory information to the system to create a new sales territory instance.
Update Sales Territory
Partial update of sales territory instance in the system.
List Competitors
Specify query parameters to return desired competitor records from the system.
Get Competitor
Read a specific competitor using the competitor ID.
Create Competitor
Send competitor information to the system to create a new competitor entity.
Update Competitor
Update competitor attributes in the system.
List Competitor Products
Specify query parameters to return desired competitor product records from the system.
Get Competitor Product
Read a specific competitor product using the competitor product ID.
Create Competitor Product
Send competitor product information to the system to create a new competitor product entity.
List Cases
Specify query parameters to return desired case records from the system.
Get Case
Query the system for a specific case using the case ID.
Create Case
Send case information to the system to create a new case entity.
Update Case
Update case attributes in the system.
List Service Categories
Specify query parameters to return desired service categories from the system.
Get Service Category
Query the system for a specific service category using the service category id.
Create Service Category
Send service category information to the system to create a new service category.
List Service Catalogs
Specify query parameters to return desired service catalogs from the system.
Get Service Catalog
Query the system for a specific service catalog using the service catalog id.
Create Service Catalog
Send service catalog information to the system to create a new service catalog.
List Accounts
Specify query parameters to return desired account records from the system.
Get Account
Read a specific account using the account ID.
Create Account
Send account information to the system to create a new account.
Update Account
Update account attributes in the system.
List Contact Persons
Specify query parameters to return desired contact person records from the system.
Get Contact Person
Read a specific contact person using the contact person ID.
Create Contact Person
Send contact person information to the system to create a new contact person.
Update Contact Person
Update contact person attributes in the system.
List Individual Customers
Specify query parameters to return desired individual customer records from the system.
Get Individual Customer
Read a specific individual customer using the individual customer ID.
Create Individual Customer
Send individual customer information to the system to create a new individual customer.
Update Individual Customer
Update individual customer attributes in the system.
List Account Hierarchies
Specify query parameters to return desired account hierarchy records from the system.
Get Account Hierarchy
Read a specific account hierarchy using the account ID.
Create Account Hierarchy
Send account hierarchy information to the system to create a new account hierarchy instance.
Update Account Hierarchy
Partial update of account hierarchy instance in the system.
List Service Orders
Specify query parameters to return desired service order records from the system.
Get Service Order
Query the system for a specific service order using the ID.
Create Service Order
Send service order information to the system to create a new service order entity.
Update Service Order
Update service order attributes in the system.
List Service Quotations
Specify query parameters to return desired service quotation records from the system.
Get Service Quotation
Query the system for a specific service quotation using the ID.
Update Service Quotation
Update service quotation attributes in the system.
List Return Orders
Specify query parameters to return desired return order records from the system.
Get Return Order
Query the system for a specific return order using the ID.
Create Return Order
Send return order information to the system to create a new return order entity.
Update Return Order
Update return order attributes in the system.
List Service Order Types
Query Service Order Types.
List Service Order Priorities
Query Service Order Priorities.
List Return Order Types
Query Return Order Types.
List Return Order Return Reasons
Query Return Reason.
List Registered Products
Shows all registered product entities that matches the supplied query parameters.
Get Registered Product
Shows the registered product entity for the given registered product ID.
Create Registered Product
Creates a new registered product entity with the details send in the request.
Update Registered Product
Modifies the registered product entity for the given registered product ID.
Delete Registered Product
Deletes the registered product entity for the given registered product ID.
List Installed Bases
Shows all installed base entities that matches the supplied query parameters.
Get Installed Base
Shows the installed base entity for the given installed base ID.
Create Installed Base
Creates a new installed base entity with the details send in the request.
Update Installed Base
Modifies the installed base entity for the given installed base ID.
Delete Installed Base
Deletes the installed base entity for the given installed base ID.
List Functional Locations
Shows all functional location entities that matches the supplied query parameters.
Get Functional Location
Shows the functional location entity for the given functional location ID.
Create Functional Location
Creates a new functional location entity with the details send in the request.
Update Functional Location
Modifies the functional location entity for the given functional location ID.
List Warranties
Shows all warranty entities that matches the supplied query parameters.
Get Warranty
Shows the warranty entity for the given warranty ID.
Create Warranty
Creates a new warranty entity with the details send in the request.
List Leads
Specify query parameters to return desired lead entities.
Get Lead
Retrieve a specific lead using the lead ID.
Create Lead
Send lead information to create a new lead entity.
Update Lead
Update lead attributes using the lead ID.
Delete Lead
Delete a lead using the lead ID.
List Opportunities
Specify query parameters to return desired opportunity records from the system.
Get Opportunity
Query the system for a specific opportunity using the opportunity ID.
Create Opportunity
Send opportunity information to the system to create a new opportunity entity.
Update Opportunity
Update opportunity attributes in the system.
Delete Opportunity
Delete an opportunity by ID.
List Lead Statuses
Query all (active/inactive) lead status.
List Lead Sources
Query all (active/inactive) lead sources.
List Lead Qualifications
Query all (active/inactive) lead qualifications.
List Lead Categories
Query all (active/inactive) lead categories.
List Opportunity Sales Cycles
Query opportunity sales cycles.
List Opportunity Sales Cycle Sales Phases
Query opportunity sales phases.
List Opportunity Sources
Query opportunity sources.
List Opportunity Categories
Query opportunity categories.
List Opportunity Forecast Categories
Query opportunity forecast categories.
List Opportunity Status Reasons
Query opportunity reason for status.
List Opportunity Life Cycle Statuses
Query opportunity lifecycle status.
List Opportunity Contact Party Roles
Query opportunity contact roles.
List Notes
Shows all notes that match the supplied query parameters.
Get Note
Reads a note by ID.
Create Note
Creates a new note.
Replace Note
Modifies the note for the given ID.
Delete Note
Deletes the note by ID.
Get Document
Query the system for a specific attachment using the document ID.
Create Document
Create an attachment entry in the document service. In response, a pre-signed upload URL is received. Upload the attachm…
List Time Logs
Specify query parameters to return desired time logs from the system.
Get Time Log
Query the system for a specific time log using the time log ID.
Create Time Log
Send time log information to the system to create a new time log entry. Only object type 2886 (case) is currently suppor…
Update Time Log
Partially update a time log for the given time log ID. Only the following fields can be updated - duration, endDateTime,…
List Employees
Specify query parameters to return desired employee records from the system.
Get Employee
Read a specific employee using the employee ID.
Create Employee
Send employee information to the system to create a new employee.
Update Employee
Update employee attributes in the system.
List Scim Users
This operation returns a list of users in the system. You can filter the results using the optional filter parameter.
Get Scim User
This operation returns a user in the system by specifying the user ID.
Create Scim User
This operation creates a new user in the system.
Update Scim User
This operation updates only the specified fields of the user in the system by specifying the user ID.
Delete Scim User
This operation deletes a user in the system by specifying the user ID.
List Scim Groups
The operation returns all user groups of the system. You can filter the results using the filter parameter.
Get Scim Group
The operation returns the details of a user group specified by the ID.
Create Scim Group
The operation creates a new user group in the system.
List Organizational Units
Specify query parameters to return desired organizational unit records from the system.
Get Organizational Unit
Read a specific organizational unit using the organizational unit ID.
Create Organizational Unit
Send organizational unit information to the system to create a new organizational unit entity.
List Products
Specify query parameters to return desired product records from the system.
Get Product
Read a specific product using the product ID.
Create Product
Send product information to the system to create a new product entity.
Update Product
Update product attributes in the system.
List Product Lists
Query Product List.
Get Product List
Read Product List.
Create Product List
Create Product List.
List Product List Products
Query Products.
Get Product List Product
Read Products.
Create Product List Product
Add Products to Product List.
List Product Groups
Specify query parameters to return desired product group records from the system.
Get Product Group
Read a specific product group using the product group ID.
Create Product Group
Send product group information to the system to create a new product group entity.
List Product Types
Specify query parameters to return desired product product type records from the system.
List Product Units Of Measure
Specify query parameters to return desired product unit of measure records from the system.
List Sales Quotes
Specify query parameters to return sales quotes.
Get Sales Quote
Retrieve a sales quote using the sales quote ID.
Create Sales Quote
Send sales quote information to create a sales quote entity.
Update Sales Quote
Update a sales quote by ID.
Delete Sales Quote
Delete a sales quote by ID.
List Sales Quote Items
Specify query parameters to return sales quotes items.
Get Sales Quote Item
Read a sales quote item by sales quote id.
Create Sales Quote Item
Create sales quote item.
Update Sales Quote Item
Update a sales quote item.
Delete Sales Quote Item
Delete a sales quote item by Id.
List Sales Contracts
Specify query parameters to return desired sales contract records from the system.
Get Sales Contract
Query the system for a specific sales contract using the sales contract ID.
Create Sales Contract
Create a new sales contract in the system.
Update Sales Contract
Update a sales contract by ID.
Delete Sales Contract
Delete a sales contract by ID.
List Sales Quote Document Types
Specify query parameters to return sales quote document types.
List Sales Quote Item Types
Query quote item types.