Create User Audience

POST

/v1/organizations/:organizationId/apps/:applicationId/user-audiences/

Create User Audience

Required Permission: mad.userAudience.application.create

Create User Audience

Request

Add parameter in 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

name string required

description string optional

filter object required

groups array [array] required

emails array [string] required

usersScope string required

org app

{
    "name": "string",
    "description": "string",
    "filter": {
        "groups": [
            [
                "string"
            ]
        ],
        "emails": [
            "[email protected]"
        ]
    },
    "usersScope": "org"
}

Responses

200 Response application/json

status boolean required

data object required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

description string optional

organizationId string required

Match pattern: ^[a-fA-F0-9]{24}$

applicationId string optional

Match pattern: ^[a-fA-F0-9]{24}$

application object optional

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

slug string required

picture string required

filter object required

groups array [array] required

emails array [string] required

usersScope string required

org app

allowedApplicationIds array [string] required

allowedApplications array [object] required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

slug string required

picture string required

counts object required

pubApps number optional

members number optional

unmatchedEmails number optional

createdAt string required

updatedAt string required

{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "organizationId": "string",
        "applicationId": "string",
        "application": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "picture": "string"
        },
        "filter": {
            "groups": [
                [
                    "string"
                ]
            ],
            "emails": [
                "[email protected]"
            ]
        },
        "usersScope": "org",
        "allowedApplicationIds": [
            "string"
        ],
        "allowedApplications": [
            {
                "id": "string",
                "name": "string",
                "slug": "string",
                "picture": "string"
            }
        ],
        "counts": {
            "pubApps": 0,
            "members": 0,
            "unmatchedEmails": 0
        },
        "createdAt": "string",
        "updatedAt": "string"
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5174

message string optional

Invalid action

{
    "status": false,
    "error": {
        "code": 5174,
        "message": "Invalid action"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4001

message string optional

Unauthorized

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