Bulk create idea manager members

POST

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

Bulk Create Users in Segment or Idea Manager

Endpoint

POST /bulk-create-user/:id?

Description

Bulk creates users in a specified segment, or in the Idea Manager if no id is provided. If a segment ID is supplied, users are added to that specific segment; otherwise, users are created within the Idea Manager's general user base.

URL Parameters

id (optional, integer) - The ID of the segment to add users to. If not provided, users will be created in the Idea Manager.

Request Headers

Content-Type: application/json

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 application/json

array of:

name

string

required

string

required

Example

[
  {
    "name": "Aisha Khan",
    "email": "aisha.khan@shorterloop.com"
  },
  {
    "name": "Ravi Singh",
    "email": "ravi.singh@shorterloop.com"
  },
  {
    "name": "Neha Gupta",
    "email": "neha.gupta@shorterloop.com"
  },
  {
    "name": "Karan Joshi",
    "email": "karan.joshi@shorterloop.com"
  },
  {
    "name": "Meera Patel",
    "email": "meera.patel@shorterloop.com"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.shorterloop.com/api/v2/idea-manager/bulk-create-user/19' \
--header 'Authorization;' \
--header 'initiativeId;' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "name": "Aisha Khan",
    "email": "aisha.khan@shorterloop.com"
  },
  {
    "name": "Ravi Singh",
    "email": "ravi.singh@shorterloop.com"
  },
  {
    "name": "Neha Gupta",
    "email": "neha.gupta@shorterloop.com"
  },
  {
    "name": "Karan Joshi",
    "email": "karan.joshi@shorterloop.com"
  },
  {
    "name": "Meera Patel",
    "email": "meera.patel@shorterloop.com"
  }
]'

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": 1692,
          "email": "rahul.sharma1@shorterloop.com",
          "role": "idm_member",
          "updatedAt": "2024-10-29T00:51:59.812Z",
          "createdAt": "2024-10-29T00:51:59.812Z"
        }
      },
      {
        "success": true,
        "user": {
          "id": 1693,
          "email": "pooja.mehta1@shorterloop.com",
          "role": "idm_member",
          "updatedAt": "2024-10-29T00:51:59.896Z",
          "createdAt": "2024-10-29T00:51:59.896Z"
        }
      },
      {
        "success": true,
        "user": {
          "id": 1694,
          "email": "amit.verma2@shorterloop.com",
          "role": "idm_member",
          "updatedAt": "2024-10-29T00:51:59.913Z",
          "createdAt": "2024-10-29T00:51:59.913Z"
        }
      },
      {
        "success": true,
        "user": {
          "id": 1695,
          "email": "drawat+28oct1@shorterloop.com",
          "role": "idm_member",
          "updatedAt": "2024-10-29T00:51:59.930Z",
          "createdAt": "2024-10-29T00:51:59.930Z"
        }
      },
      {
        "success": true,
        "user": {
          "id": 1696,
          "email": "drawat+28oct@shorterloop.com",
          "role": "idm_member",
          "updatedAt": "2024-10-29T00:51:59.945Z",
          "createdAt": "2024-10-29T00:51:59.945Z"
        }
      }
    ],
    "segmentCount": 0
  }
}

Modified at 2024-10-30 06:06:05

Sending email to selected idm members

Import Users (CSV/JSON) in IDM

Bulk create idea manager members

Bulk Create Users in Segment or Idea Manager#

Endpoint#

Description#

URL Parameters#

Request Headers#

Request

Request samples

Responses

Bulk Create Users in Segment or Idea Manager

Endpoint

Description

URL Parameters

Request Headers