{"info":{"_postman_id":"635233d3-bf74-4b41-97b8-5b5c05d6b400","name":"SalesScreen API","description":"

AUTHORIZATION

Your API key can be created inside SalesScreen by going to Settings -> Api Keys -> \"Add API key\".

Use the generated key in the header of all requests:

\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY	VALUE
apiKey	{ your apiKey }

Rate limits

1s: 15

1m: 200

CORE CONCEPTS

All IDs in requests sent to SalesScreen should be IDs from your system.When you send a list to /Record/Add each of the list elements have an Id and an UserId from your system. We use these Ids to track the records and users in SalesScreen, if a match on a record is found it is updated accordingly.
\n
Activity Types and ActivitiesActivity Types are categories/buckets for your Activities. Say you want to track three different subscriptions: small, medium and large. Your Activities could be \"small\", \"medium\" and \"large\", while the Activity Type would be \"Subscriptions\".
\n
Everything is automatically createdIf a record contains something (Activity, User, Team etc.) that does not exist in SalesScreen we create it, there are no seperate endpoints for adding content to SalesScreen.
\n
Date
The date used for createdDate is the primary time decider in SalesScreen for widgets, competitions, events and so on. The date chosen here will depend on the context of what you send, it can be the date an Order was accepted or the time of a sent Email.
\n

DEVELOPMENT DETAILS

Get started by looking at the /Record/Add endpoint below and the supplied request body, which will add a record to SalesScreen and at the same time create the associated Activity Type, Activity and User in your SalesScreen account.

Tip: log in to SalesScreen to see an overview of all the activities, users, teams etc. you have added to SalesScreen in the Mappings section, you'll find it under Settings.

Activity Type, Activity, Team and Dropdown1, Dropdown2 entities are automatically created if they do not exist, also users will be added automatically if the User contains both an Id and an email.

If it is not practical to include the user email for every request to /Record/Add the endpoint will return the error code \"missingUser\" and a list of the missing users. Typical workflow would then be:

Send a list records - Record/Add
\n
Handle any missing users - User/Add
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"302212","collectionId":"635233d3-bf74-4b41-97b8-5b5c05d6b400","publishedId":"SVSBxDUK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"333333","highlight":"1EAFAA"},"publishDate":"2019-08-21T11:44:36.000Z"},"item":[{"name":"Main Implementation","item":[{"name":"/Record/Add","id":"7172ed26-da20-4963-8b80-427ee319e996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apiKey","type":"text","value":"{{apiKey}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": \"1234567\",\n \"activityTypeName\": \"Sale\",\n \"user\": {\n \"id\": \"user_1234\",\n \"email\": \"[your email]\",\n \"firstname\": \"John\",\n \"lastname\": \"Doe\"\n },\n \"activity\": {\n \"key\": \"pro package\",\n \"name\": \"\"\n },\n \"quantity\": 1,\n \"value1\": 2000,\n \"text1\": \"Customer A\"\n }\n]"},"url":"https://connect.salesscreen.com/api/v1/Record/Add","description":"

Get started

Please copy the base json in the Body below and fill in your email to get started. Then add properties as you see fit from the Record model definition.

Complete Record model

Records
\n
- Id (required): Unique ID of the record you are sending to SalesScreen.
  \n
- ActivityTypeName (required): Unique string for Activity Type.
  \n
- User (required): creator/owner
  \n
  - Id (required): Unique ID of the creator/owner of the record.
    \n
  - Email (optional): string
    \n
  - Firstname (optional): string
    \n
  - Lastname (optional): string
    \n
  - Team (optional)
    \n
    - Key: unique Key or Name.
      \n
    - Name: string
      \n
    \n
  \n
- Activity (required)
  \n
  - Key (required): unique Key or Name for the Activity.
    \n
  - Name (optional): string
    \n
  \n
- Quantity (required): int
  \n
- Value1: double
  \n
- Value2: double
  \n
- Value3: double
  \n
- Text1: string
  \n
- Text2: string
  \n
- CreatedDate: ISO 8601 UTC. Specify no date and we set it to Now (if the record is not an edit).
  \n
- Date2: ISO 8601 UTC
  \n
- Dropdown1: Dynamic filter value (i.e. origin, source or status)
  \n
  - Key: unique Key or Name.
    \n
  - Name: string
    \n
  \n
- Dropdown2: Dynamic filter value (i.e. origin, source or status)
  \n
  - Key: unique Key or Name.
    \n
  - Name: string
    \n
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","v1","Record","Add"],"host":["connect","salesscreen","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7172ed26-da20-4963-8b80-427ee319e996"},{"name":"/User/Add","id":"129a43a0-1a6b-4b7e-8bc3-6f015fa97981","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"apiKey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"userId\": \"user_1234\",\n\t\"email\": \"johndoe@salesscreen.com\",\n\t\"firstname\": \"John\",\n\t\"lastname\": \"Doe\",\n \"imageUrl\": \"your_public_url\",\n \"team\": {\n \"key\": \"my_super_team\", \n \"name\": \"Super Team\"\n }\n}"},"url":"https://connect.salesscreen.com/api/v1/User/Add","description":"

UserId is the same Id of the User you specify when adding records.
ImageUrl is optional and can also be uploaded by the user inside the plattform.

\n","urlObject":{"protocol":"https","path":["api","v1","User","Add"],"host":["connect","salesscreen","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"129a43a0-1a6b-4b7e-8bc3-6f015fa97981"}],"id":"65941ab7-4fb8-48b9-820d-f2ff0b158a82","event":[{"listen":"prerequest","script":{"id":"11c0785d-ac75-4c3a-b256-188d0d06abd9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"767eb27f-edf7-491f-8875-835b7d66e480","type":"text/javascript","exec":[""]}}],"_postman_id":"65941ab7-4fb8-48b9-820d-f2ff0b158a82","description":""},{"name":"Support Function","item":[{"name":"/ActivityType/Get","id":"26a6ab11-75c6-4f5f-8d25-35fd39e93e27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apiKey","value":"{{apiKey}}","type":"text"}],"url":"https://connect.salesscreen.com/api/v1/ActivityType/Get","urlObject":{"protocol":"https","path":["api","v1","ActivityType","Get"],"host":["connect","salesscreen","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"26a6ab11-75c6-4f5f-8d25-35fd39e93e27"},{"name":"/User/DisableByEmail","id":"43609e59-5f15-4ac2-ba12-c71a8dbe9c87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apiKey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john.doe@testco.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://connect.salesscreen.com/api/v1/User/DisableByEmail","urlObject":{"protocol":"https","path":["api","v1","User","DisableByEmail"],"host":["connect","salesscreen","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"43609e59-5f15-4ac2-ba12-c71a8dbe9c87"}],"id":"88d55bc5-862d-47ad-b534-7bd9dfdf7e9b","description":"

/ActivityType/Get\nlists the Activity Types in your company with properties for each type and their custom name.

Use case for this is primarily if Activity Types have been defined in SalesScreen and you do not have access to the account.

Each Activity Type has the same available fields (quantity, value2, value3...) but they might be very different in the context of the type. Example: you have two Activity Types \"Sales\" and \"Calls\" the value2 field could be \"sale value\" and \"call duration\" respectively.

\n","event":[{"listen":"prerequest","script":{"id":"481c242c-c813-4ffc-8c3e-70e257665c2b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7b376764-01b3-40da-b9b9-87c477a9694d","type":"text/javascript","exec":[""]}}],"_postman_id":"88d55bc5-862d-47ad-b534-7bd9dfdf7e9b"}],"event":[{"listen":"prerequest","script":{"id":"21994068-9115-4f5e-b39a-8e07919f081f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fb9030fd-bb6d-472f-a506-47dba9d04473","type":"text/javascript","exec":[""]}}]}