Preview segment permission

POST

/v1/organizations/:organizationId/segment-permissions/preview

Preview segment permission

Required Permission: base.organization.segmentPermission.preview

Preview segment permission

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json

users object required

emails array [string] required

groups array [array] required

{
    "users": {
        "emails": [
            "[email protected]"
        ],
        "groups": [
            [
                "string"
            ]
        ]
    }
}

Responses

200 Response application/json

status boolean required

data object required

matchedUsers array [string] required

{
    "status": true,
    "data": {
        "matchedUsers": [
            "[email protected]"
        ]
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}