Import Users (CSV/JSON)

POST

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

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

{
  "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
  }
}

Retrieve segment with users

Sending email to segment members

Import Users (CSV/JSON)

Endpoint#

Description#

URL Parameters#

Request

Request samples

Responses

Endpoint

Description

URL Parameters