You are here: Home > API Reference > Platform > User Audience > Apps > Get User Audience preview

Get User Audience preview

Required Permission: mad.userAudience.application.preview

Get User Audience preview

POST
https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/user-audiences/preview

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^[a-fA-F0-9]{24}$
applicationId string
required
Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json
filter object required
groups array [array] required
emails array [string] required
usersScope string required
org app
{
    "filter": {
        "groups": [
            [
                "string"
            ]
        ],
        "emails": [
            "user@example.com"
        ]
    },
    "usersScope": "org"
}

Responses

200 Response application/json
members object required 
{
    "members": {}
}
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"
    }
}
Was this page helpful?