Favicon

You are here: Home > API Reference > Platform > User Audience > Update User Audience

PUT /organizations/:organizationId/user-audiences/:userAudienceId

Required Permission: mad.userAudience.organization.update

Update User Audience

PUT
https://api.applivery.io/v1/organizations/{organizationId}/user-audiences/{userAudienceId} 
curl -X PUT "https://api.applivery.io/v1/organizations/{organizationId}/user-audiences/{userAudienceId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "filter": {
    "groups": [],
    "emails": []
  },
  "allowedApplicationIds": [
    "string"
  ]
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/user-audiences/{userAudienceId}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "filter": {
      "groups": [],
      "emails": []
    },
    "allowedApplicationIds": [
      "string"
    ]
  }),
});

const data = await response.json();
import requests

response = requests.put(
    "https://api.applivery.io/v1/organizations/{organizationId}/user-audiences/{userAudienceId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "name": "string",
      "description": "string",
      "filter": {
        "groups": [],
        "emails": []
      },
      "allowedApplicationIds": [
        "string"
      ]
    },
)

data = response.json()

Request

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

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

Body Params application/json
name string optional
description string optional
filter object optional
groups array [array] required
emails array [string] required
allowedApplicationIds array [string] optional 
{
    "name": "string",
    "description": "string",
    "filter": {
        "groups": [
            [
                "string"
            ]
        ],
        "emails": [
            "[email protected]"
        ]
    },
    "allowedApplicationIds": [
        "string"
    ]
}

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"
    }
}
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"
    }
}
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"
    }
}