Upsert Segment

Production

https://api.mircate.com/5p1hp1d2t

POST

/CALL/LoyaltyAPI/upsertSegment/{MIRCATE_PROJECT_ID}

Last modified:2025-09-30 15:00:44

Used to create a new segment.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Example

{
    "name": "EMPLOYEES",
    "type": "static",
    "description": "Company Employees"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mircate.com/5p1hp1d2t/CALL/LoyaltyAPI/upsertSegment/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "EMPLOYEES",
    "type": "static",
    "description": "Company Employees"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "_id": "6784e8fecf9850bf660f5a60",
    "code": "segment01"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-09-30 15:00:44

Get Entity Events

Add User To Segment