1. Where can I find the SalesScreen API Documentation?
You can access the full SalesScreen API documentation here:
SalesScreen API Documentation
2. What should I use as the unique User ID?
The User ID can be anything unique, but it is recommended to use email as the User ID. This makes it easier to maintain consistency, as users already have their email addresses in the SalesScreen platform.
3. What should I use as the Record ID?
The Record ID should be a unique identifier for the record you are sending. If you're sending data from a CRM, a common choice for the Record ID is an Opportunity ID or Deal ID. This ensures that the same record can be updated if the data is sent again with the same ID.
4. What is an Activity Type?
An Activity Type refers to the category or object of the data you are sending. For example:
Sales: Represents a sale or transaction.
Opportunities: Represents an opportunity or lead.
Each type helps organize and categorize the data in the platform, allowing for easier reporting and tracking.
5. What types of fields are available in the API?
Here are the main types of fields you can use when sending data:
Activity Type: The object or category of the data (e.g., Sales, Opportunities).
Activity: A description or highlight of what happened, such as deal stages or call outcomes.
Numeric Fields:
Quantity: The number of items or deals. It's generally recommended to set this to 1 to count reports.
Value1, Value2, Value3: Fields to store numerical values (e.g., deal size, revenue, etc.).
Text Fields:
Text1, Text2: Fields for textual data, typically used for company names, opportunity names, etc.
Date Fields:
CreatedDate: The date the report is added. If not specified, the current date is used. Commonly used for created and closed dates.
Date2: For any additional dates that might be relevant.
Dropdown Fields:
Dropdown1, Dropdown2: These fields are used for additional information that can be filtered on the platform, such as status, source, etc.
6. What is the difference between 'Key' and 'Name'?
Key: The unique mapping value used internally to identify an object or attribute.
Name: The human-readable label that is displayed on the front end.
If the Key and Name are the same, you only need to send the Key. If the Name changes often, using the Key ensures that the value remains consistent and avoids duplicates.
7. I am worried about hitting rate limits. What should I do?
To avoid hitting rate limits, you can send your data as a list instead of sending one record at a time. This reduces the number of individual requests and helps you stay within the API's rate limits.
8. Should I send Team data?
No, it is not recommended to send team data through the API. Team management and settings should be handled directly in the SalesScreen platform.
9. I need help designing my API request. Who should I contact?
If you need assistance with designing your API request, you can contact:
SalesScreen Support: Send an email to [email protected]
Customer Success Manager: Reach out to your assigned customer success manager for personalized support.