Bulk create users to a segment

POST

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

Bulk Create Users in Segment

Endpoint

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

Description

Bulk creates new users associated with a specific segment identified by segmentId. This allows you to provide a list of user information to be added to the segment.

URL Parameters

segmentId (integer) - The ID of the segment to which the users will be added. Example: 18

Request Headers

Content-Type: application/json

Request Body

Provide an array of user objects, each containing the user’s name and email.

Example Request Body

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

Request

Header Params

Body Params application/json

Example

[
  {
    "name": "Anjali Singh",
    "email": "anjali.singh@shorterloop.com"
  },
  {
    "name": "Ravi Kumar",
    "email": "ravi.kumar@shorterloop.com"
  },
  {
    "name": "Neha Patel",
    "email": "neha.patel@shorterloop.com"
  },
  {
    "name": "Vikas Gupta",
    "email": "vikas.gupta@shorterloop.com"
  },
  {
    "name": "Priya Nair",
    "email": "priya.nair@shorterloop.com"
  }
]

Request Code 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;' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "name": "Anjali Singh",
    "email": "anjali.singh@shorterloop.com"
  },
  {
    "name": "Ravi Kumar",
    "email": "ravi.kumar@shorterloop.com"
  },
  {
    "name": "Neha Patel",
    "email": "neha.patel@shorterloop.com"
  },
  {
    "name": "Vikas Gupta",
    "email": "vikas.gupta@shorterloop.com"
  },
  {
    "name": "Priya Nair",
    "email": "priya.nair@shorterloop.com"
  }
]'

Responses

🟢200OK

application/json

Body

{
    "success": true,
    "message": "Users copied to segment successfully",
    "data": {
        "inviteResults": [
            {
                "success": true,
                "user": {
                    "id": 1827,
                    "email": "anjali.singh@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T10:48:49.867Z",
                    "createdAt": "2024-10-29T10:48:49.867Z",
                    "firstName": "Anjali Singh"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1828,
                    "email": "ravi.kumar@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T10:48:49.925Z",
                    "createdAt": "2024-10-29T10:48:49.925Z",
                    "firstName": "Ravi Kumar"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1829,
                    "email": "neha.patel@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T10:48:49.979Z",
                    "createdAt": "2024-10-29T10:48:49.979Z",
                    "firstName": "Neha Patel"
                }
            },
            {
                "success": true,
                "user": {
                    "id": 1830,
                    "email": "vikas.gupta@shorterloop.com",
                    "role": "idm_member",
                    "updatedAt": "2024-10-29T10:48:50.014Z",
                    "createdAt": "2024-10-29T10:48:50.014Z",
                    "firstName": "Vikas Gupta"
                }
            }
        ],
        "segmentCount": 5
    }
}

Modified at 2024-10-29 10:49:15

Removes a segment

Manage user segments: move or remove

Bulk create users to a segment

Bulk Create Users in Segment#

Endpoint#

Description#

URL Parameters#

Request Headers#

Request Body#

Example Request Body#