API Reference

Update an existing audience

patch
https://platform.{env}.simpplr.com/v1/b2b/identity/audiences/

This API allows you to update an existing audience

Note:

The Update Audience request does not support the parentId field.

Please refer to the Create Audience documentation for detailed guidance.

Path Params
uuid
required

The ID of the audience to update

Body Params
string
required
length ≥ 1

Name of the audience

string
enum
required

Type of audience

Allowed:
string | null

Description of the audience

rule
object
required

Audience rule configuration with flexible AND/OR structure

string | null

Audience category name.

This is valid for only ABAC enabled tenants. For non-ABAC tenants, if you pass anything here it will throw error.

When we need to move audience inside an existing category or new category.

When you pass categoryName in request audience and its children move inside that category if category with same name already exist otherwise will create new category first and move audience inside it.

We can only move hierarchy level 1 audience using this field.

uuid

Audience category ID.

This is valid for only ABAC enabled tenants. For non-ABAC tenants, if you pass anything here it will throw error.

When you pass categoryId in request audience and its children move inside that category.

We can only move hierarchy level 1 audience using this field.

Responses

Updated 2 months ago

Language
Credentials
OAuth2
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago