Shorter Loop API Documentation
API ReferencesRelease NotesHelp CenterKnowledge Base
API ReferencesRelease NotesHelp CenterKnowledge Base
Sign In
  1. Segments
  • 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
        GET
      • Create segment
        POST
      • Modify a segment
        PUT
      • Removes a segment
        DELETE
      • Bulk create users to a segment
        POST
      • Manage user segments: move or remove
        PUT
      • Retrieve segments with users
        GET
      • Retrieve segment with users
        GET
      • Import Users (CSV/JSON)
        POST
      • Sending email to segment members
        POST
      • Sending email to selected idm members
        POST
    • 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
  • 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. Segments

Import Users (CSV/JSON)

POST
/api/v2/segments/18/create-users
v2

Endpoint#

POST /api/v2/segments/:segmentId/create-users

Description#

Creates new users associated with a specific segment identified by segmentId. This endpoint allows for bulk user creation based on the provided data.

URL Parameters#

segmentId (integer) - The ID of the segment in which to create users. Example: 18

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/segments/18/create-users' \
--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": 1831,
                    "email": "aarav.kapoor11234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.056Z",
                    "createdAt": "2024-10-30T05:10:28.056Z",
                    "firstName": "Aarav Kapoor"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1832,
                    "email": "meera.singh11234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.151Z",
                    "createdAt": "2024-10-30T05:10:28.151Z",
                    "firstName": "Meera Singh"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1833,
                    "email": "vikram.pate1l1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.187Z",
                    "createdAt": "2024-10-30T05:10:28.187Z",
                    "firstName": "Vikram Patel"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1834,
                    "email": "nisha.iyer11234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.209Z",
                    "createdAt": "2024-10-30T05:10:28.209Z",
                    "firstName": "Nisha Iyer"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1835,
                    "email": "rohan.desai11234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.226Z",
                    "createdAt": "2024-10-30T05:10:28.226Z",
                    "firstName": "Rohan Desai"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1836,
                    "email": "ananya.rao1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.245Z",
                    "createdAt": "2024-10-30T05:10:28.245Z",
                    "firstName": "Ananya Rao"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1837,
                    "email": "karan.shah1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.261Z",
                    "createdAt": "2024-10-30T05:10:28.261Z",
                    "firstName": "Karan Shah"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1838,
                    "email": "ria.mehta1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.283Z",
                    "createdAt": "2024-10-30T05:10:28.283Z",
                    "firstName": "Ria Mehta"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1839,
                    "email": "sahil.joshi1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.318Z",
                    "createdAt": "2024-10-30T05:10:28.318Z",
                    "firstName": "Sahil Joshi"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1840,
                    "email": "tara.khanna1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.339Z",
                    "createdAt": "2024-10-30T05:10:28.339Z",
                    "firstName": "Tara Khanna"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1841,
                    "email": "dev.arora1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.356Z",
                    "createdAt": "2024-10-30T05:10:28.356Z",
                    "firstName": "Dev Arora"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1842,
                    "email": "sana.ali1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.370Z",
                    "createdAt": "2024-10-30T05:10:28.370Z",
                    "firstName": "Sana Ali"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1843,
                    "email": "ravi.bhatt1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.386Z",
                    "createdAt": "2024-10-30T05:10:28.386Z",
                    "firstName": "Ravi Bhatt"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1844,
                    "email": "leela.deshmukh1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.399Z",
                    "createdAt": "2024-10-30T05:10:28.399Z",
                    "firstName": "Leela Deshmukh"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1845,
                    "email": "vikas.bedi1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.417Z",
                    "createdAt": "2024-10-30T05:10:28.417Z",
                    "firstName": "Vikas Bedi"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1846,
                    "email": "priya.nair1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.432Z",
                    "createdAt": "2024-10-30T05:10:28.432Z",
                    "firstName": "Priya Nair"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1847,
                    "email": "amit.chauhan1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.452Z",
                    "createdAt": "2024-10-30T05:10:28.452Z",
                    "firstName": "Amit Chauhan"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1848,
                    "email": "simran.kaul1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.475Z",
                    "createdAt": "2024-10-30T05:10:28.475Z",
                    "firstName": "Simran Kaul"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1849,
                    "email": "jay.kapoor1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.487Z",
                    "createdAt": "2024-10-30T05:10:28.487Z",
                    "firstName": "Jay Kapoor"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1850,
                    "email": "neha.sethi1234599@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-30T05:10:28.503Z",
                    "createdAt": "2024-10-30T05:10:28.503Z",
                    "firstName": "Neha Sethi"
                }
            }
        ],
        "segmentCount": 20
    }
}
Modified at 2024-10-29 02:51:02
Previous
Retrieve segment with users
Next
Sending email to segment members
Built with