Shorter Loop API Documentation
API ReferencesRelease NotesHelp CenterKnowledge Base
API ReferencesRelease NotesHelp CenterKnowledge Base
Sign In
  1. Idea manager
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
    • 2 way Jira Integration
    • Create webhook in Shorter Loop
  • Metrics
    • Create a Key Performance Indicator (KPI)
      POST
    • Update the Key Performance Indicator (KPI)
      PUT
    • Retrieve KPIs not linked to specific product backlog items
      GET
    • Insert KPI's records (Body JSON Payload)
      POST
    • Insert KPI's records (Upload CSV)
      POST
    • Insert KPI's records (Upload JSON)
      POST
  • Idea manager
    • Feedback Collection
      • Create idea and issue
      • Retrieves a list of categories
      • Modify feedback item
      • Removes a feedback item
      • Upvote or downvote a work item
      • Retrieve a feedback item
      • Get comments for a feedback item.
      • Reply to a comment
      • Modify a comment
      • Bulk create feedback items: CSV and JSON
    • Segments
      • Retrieves a list of segments without users
      • Create segment
      • Modify a segment
      • Removes a segment
      • Bulk create users to a segment
      • Manage user segments: move or remove
      • Retrieve segments with users
      • Retrieve segment with users
      • Import Users (CSV/JSON)
      • Sending email to segment members
      • Sending email to selected idm members
    • Bulk create idea manager members
      POST
    • Import Users (CSV/JSON) in IDM
      POST
    • Bulk re-invite in IDM
      PUT
  • Backlog Management
    • Epics
      • Create a new epic
      • Modify an epic
      • Retrieve details of the epic
      • Removes the epic
    • Features
      • Create a new feature
      • Modify a feature
      • Retrieve details of the feature
      • Removes the feature
    • User stories
      • Create a new user story
      • Modify a user story
      • Retrieve user story
      • Removes the user story
    • Assets
      • Attaches files to the workitem
      • Removes an asset
      • Retrieve attachments for the backlog workitem with ID
    • Product Tags
      • Retrieves tags for initiative
    • Teams
      • Get teams and members for product
    • Personas
      • Retrieve personas associated with initiative
    • Get whole backlog tree
      GET
  • Strategy Board
    • Experiment
      • Create a new experiemnt variant
    • Solutions
      • Versions
        • Storymap versions api documentation
        • Create a version
        • Update version
        • Removes a version
        • Retrieve versions
      • Get all storymaps for solution
  • Persona Board V2
    • Segments
      • Permanently deletes a segment
      • Creates a new option
      • Retrieve a list of segments
      • Retrieve a segment
      • Create a segment
      • Removes a segment
      • Removes a segment option
      • Detaches a segment from the persona
      • Update segment option
    • Custom fields
      • Removes a custom field
      • Retrieve a list of custom fields
      • Retrieve a custom field
      • Create a custom field
      • Removes a custom field option
      • Detaches a custom field from persona
      • Retrieve custom fields excluding persona
      • Creates a new option
      • Permanently deletes a custom field
      • Update custom field
      • Update custom field option
      • Attach a custom field to a persona
    • Create opportunities from summary
    • Retrieve notes
    • Retrieve persona
    • Retrieve experiments for Persona
    • Create
    • Retrieve
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  1. Idea manager

Import Users (CSV/JSON) in IDM

POST
/api/v2/idea-manager/bulk-create-user/19
v2

Bulk Create Users in Idea Manager with CSV/JSON Upload#

Endpoint#

POST /api/v2/idea-manager/bulk-create-user/:id

Description#

Bulk creates users in the specified Idea Manager group identified by id (in this example, 19). Users can be provided through a CSV or JSON file upload.

URL Parameters#

id (integer) - The ID of the Idea Manager group in which users will be created. Example: 19

Request Headers#

Content-Type: multipart/form-data

Request Body#

Upload a CSV or JSON file containing the list of users. Each user entry must include name and email.

CSV File Format#

The CSV file should contain the following columns:
name - User’s name
email - User’s email address

Example CSV Content#

name,email
Rahul Sharma,rahul.sharma@shorterloop.com
Pooja Mehta,pooja.mehta@shorterloop.com
Amit Verma,amit.verma@shorterloop.com
Sneha Reddy,sneha.reddy@shorterloop.com
Deepak Rao,deepak.rao@shorterloop.com

Request

Header Params
Authorization
string 
required
Default:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc
initiativeId
string 
required
How to get initiativeId:
Visit https://app.shorterloop.com/ACME/product/SHO-MJXR/dashboard.
The initiativeId is SHO-MJXR in the URL.
Use this initiativeId in the initiativeId header for API requests.
Default:
DEE
Example:
MGMT
Content-Type
string 
required
Default:
application/json
Body Params multipart/form-data
metrics
file 
optional
Example:
file:///Users/dineshrawat/Downloads/unique_names_emails.csv

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.shorterloop.com/api/v2/idea-manager/bulk-create-user/19' \
--header 'Authorization;' \
--header 'initiativeId;' \
--form 'metrics=@"/Users/dineshrawat/Downloads/unique_names_emails.csv"'

Responses

🟢200OK
application/json
Body
success
boolean 
required
message
string 
required
data
object 
required
inviteResults
array [object {2}] 
required
segmentCount
integer 
required
Examples
{
    "success": true,
    "message": "Users copied to segment successfully",
    "data": {
        "inviteResults": [
            {
                "success": true,
                "user": {
                    "id": 1797,
                    "email": "aarav.kapoor112345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.503Z",
                    "createdAt": "2024-10-29T02:45:42.503Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1798,
                    "email": "meera.singh112345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.537Z",
                    "createdAt": "2024-10-29T02:45:42.537Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1799,
                    "email": "vikram.pate1l12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.567Z",
                    "createdAt": "2024-10-29T02:45:42.567Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1800,
                    "email": "nisha.iyer112345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.590Z",
                    "createdAt": "2024-10-29T02:45:42.590Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1801,
                    "email": "rohan.desai112345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.604Z",
                    "createdAt": "2024-10-29T02:45:42.604Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1802,
                    "email": "ananya.rao12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.621Z",
                    "createdAt": "2024-10-29T02:45:42.621Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1803,
                    "email": "karan.shah12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.634Z",
                    "createdAt": "2024-10-29T02:45:42.634Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1804,
                    "email": "ria.mehta12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.645Z",
                    "createdAt": "2024-10-29T02:45:42.645Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1805,
                    "email": "sahil.joshi12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.660Z",
                    "createdAt": "2024-10-29T02:45:42.660Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1806,
                    "email": "tara.khanna12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.675Z",
                    "createdAt": "2024-10-29T02:45:42.675Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1807,
                    "email": "dev.arora12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.688Z",
                    "createdAt": "2024-10-29T02:45:42.688Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1808,
                    "email": "sana.ali12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.703Z",
                    "createdAt": "2024-10-29T02:45:42.703Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1809,
                    "email": "ravi.bhatt12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.717Z",
                    "createdAt": "2024-10-29T02:45:42.717Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1810,
                    "email": "leela.deshmukh12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.730Z",
                    "createdAt": "2024-10-29T02:45:42.730Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1811,
                    "email": "vikas.bedi12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.745Z",
                    "createdAt": "2024-10-29T02:45:42.745Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1812,
                    "email": "priya.nair12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.759Z",
                    "createdAt": "2024-10-29T02:45:42.759Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1813,
                    "email": "amit.chauhan12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.773Z",
                    "createdAt": "2024-10-29T02:45:42.773Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1814,
                    "email": "simran.kaul12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.789Z",
                    "createdAt": "2024-10-29T02:45:42.789Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1815,
                    "email": "jay.kapoor12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.807Z",
                    "createdAt": "2024-10-29T02:45:42.807Z"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1816,
                    "email": "neha.sethi12345@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T02:45:42.822Z",
                    "createdAt": "2024-10-29T02:45:42.822Z"
                }
            }
        ],
        "segmentCount": 0
    }
}
Modified at 2024-10-30 06:07:09
Previous
Bulk create idea manager members
Next
Bulk re-invite in IDM
Built with