Mailmus

Audiences

Audiences Controller_list

GET
/apps/{appId}/audiences

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/audiences"
Empty

Audiences Controller_create

POST
/apps/{appId}/audiences

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/audiences" \  -H "Content-Type: application/json" \  -d '{    "name": "Newsletter subscribers"  }'
Empty

Audiences Controller_find One

GET
/apps/{appId}/audiences/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/audiences/string"
Empty

Audiences Controller_rename

PATCH
/apps/{appId}/audiences/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/apps/string/audiences/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Clients VIP"  }'
Empty

Audiences Controller_remove

DELETE
/apps/{appId}/audiences/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/audiences/string"
Empty

Audiences Controller_update Rules

PATCH
/apps/{appId}/audiences/{id}/rules

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/apps/string/audiences/string/rules" \  -H "Content-Type: application/json" \  -d '{    "match": "all",    "conditions": [      {        "field": "plan",        "operator": "eq",        "value": "pro"      }    ]  }'
Empty

Audiences Controller_recompute

POST
/apps/{appId}/audiences/{id}/recompute

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/audiences/string/recompute"
Empty

Audiences Controller_get Contacts

GET
/apps/{appId}/audiences/{id}/contacts

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/audiences/string/contacts"
Empty

Audiences Controller_add Contact

POST
/apps/{appId}/audiences/{id}/contacts

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/audiences/string/contacts" \  -H "Content-Type: application/json" \  -d '{    "contactId": "con_abc123"  }'
Empty

Audiences Controller_add Contact By Email

POST
/apps/{appId}/audiences/{id}/contacts/by-email

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/audiences/string/contacts/by-email" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
Empty

Audiences Controller_bulk Add By Emails

POST
/apps/{appId}/audiences/{id}/contacts/bulk-email

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/audiences/string/contacts/bulk-email" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Audiences Controller_remove Contact

DELETE
/apps/{appId}/audiences/{id}/contacts/{contactId}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
contactId*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/audiences/string/contacts/string"
Empty