Custom Segment API

This API allows to create a custom segment from CSV via an API call.
Unsure of the content of file? Download a sample

API Endpoint

API call is a POST method, and the URL is mentioned below.

HTTP

https://api.moengage.com/csv_segment

API Information

Response format	JSON
Requires authentication	Yes

Request Headers

HTTP

'Content-Type':'application/json'

Request Body

• appId (mandatory) : MoEngage provided APP ID. Can be found at Settings -> App Settings.

• attribute (mandatory) : Name of the user attribute on which segment is being created.
  For registered users, use user attribute ID and for Anonymous (not registered) users use email, mobile number or any other identifier as the anonymous user identifier.

• attributeType (mandatory) : Data Type of the user attribute on which segment is being created.
  Should be one of the following string, numeric, geo_point, date.

• segName (mandatory) : Name of custom segment.

• csvUrl (mandatory) : Url where CSV is hosted.
  CSV should be downloadable without authorization

• callback (mandatory) : Callback url to receive result of segment creation.

• signature (mandatory): Signature generated from a hash of App Id, Segment Name and API Secret. You can find API Id (or App Id) & API Secret in your MoEngage Dashboard under Settings->Transaction Push Settings.

• emails (optional) : List of email ids to receive segment creation response.

Python code to generate signature for authentication

from hashlib import sha256

app_id = "MAZW51234N1IMMSH5HKBHB_DEBUG" #(Please refer to required parameters section)
seg_name = "TEST"
api_secret = "S3pVzjBF9use" # This is the sample key. Each app has a different secret key
signature = sha256(app_id+'|'+ seg_name+'|'+ api_secret).hexdigest()

HTTP status code summary

Status Code	Reason
200 - OK	Everything worked as expected.
201 - Create	Status returned in callback if segment is successfully created
400 - Bad Request	The request was unacceptable, often due to missing a required parameter. Reason is passed in error_message param
401 - Unauthorized	Signature not valid.
409 - Conflict	The request conflicts with another request.
500, 502, 503, 504 - Server Errors	Something went wrong on MoEngage's end.

Sample Request

Shell

curl -H "Content-Type: application/json" -X POST 
-d '{"segName": "TEST",
"callback": "http://localhost:12345",
"csvUrl": "https://s3.amazonaws.com/Sample_GAIDs.csv",
"appId": "MAZW51234N1IMMSH5HKBHB_DEBUG",
"attribute": "email",
"signature":"d22374f405e7d8da03a7772582aedc4010be5e47d5669ad6596803a6bc277ff0",
"attributeType": "string"}' https://api.moengage.com/csv_segment

Python

import requests

request_params = dict(appId='MAZW51234N1IMMSH5HKBHB_DEBUG',
                      attribute='email',
                      attributeType='string',
                      callback='http://localhost:12345',
                      csvUrl='https://s3.amazonaws.com/Sample_GAIDs.csv',
                      segName='TEST',
                      signature='d22374f405e7d8da03a7772582aedc4010be5e47d5669ad6596803a6bc277ff0')
r = requests.post('https://pushapi.moengage.com/csv_segment', json=request_params)

API Sample Response

Success

{
  "status": 200,
 "request_id": "d5a263c4ef1198ae3d8496c0460f570f", 
  "segment_name": "TEST"
}

Duplicate

{
  "status": 409,
  "request_id": "d5a263c4ef1198ae3d8496c0460f570f", 
  "error_message": "duplicate request", 
  "segment_name": "TEST"
}

Bad Request

{
  "status": 400, 
  "error_message": "Bad Value for appId"
}

Unauthorized

{
  "status": 401, 
  "error_message": "Unauthorized"
}

Internal Server Error

{
  "status": 500, 
  "error_message": "Internal Server Error. Contact MoEngage Team",
  "segment_name": "TEST"
}

Callback Sample Body

Success

{
  "status": 201, 
  "values_found": 16, 
  "values_processed": 16, 
  "request_id": "d5a263c4ef1198ae3d8496c0460f570f", 
  "user_count": 40, 
  "segment_name": "TEST"
}

Duplicate

{
  "status": 409,
  "request_id": "d5a263c4ef1198ae3d8496c0460f570f", 
  "error_message": "duplicate request", 
  "segment_name": "TEST"
}

Failed

{
  "status": 400, 
  "segment_name": "TEST", 
  "error_message": "File download failed.", 
  "request_id": "c8e065d1851dfe114395bc9dab629284"
}

Internal Server Error

{
  "status": 500, 
  "error_message": "Internal Server Error. Contact MoEngage Team",
  "segment_name": "TEST"
}

📘

Limitation

This API does not support update or delete operations on a segment.
If the segment name already exists in the MoEngage system, the request should be rejected.