Mailmus

Contacts

Contacts Controller_list

GET
/apps/{appId}/contacts

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Query Parameters

status*string
q*string
attrKey*string
attrValue*string

Response Body

curl -X GET "https://example.com/apps/string/contacts?status=string&q=string&attrKey=string&attrValue=string"
Empty

Contacts Controller_create

POST
/apps/{appId}/contacts

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/contacts" \  -H "Content-Type: application/json" \  -d '{    "email": "contact@example.com"  }'
Empty

Contacts Controller_export Csv

GET
/apps/{appId}/contacts/export

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

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

Contacts Controller_import Csv

POST
/apps/{appId}/contacts/import

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

curl -X POST "https://example.com/apps/string/contacts/import"
Empty

Contacts Controller_batch Import

POST
/apps/{appId}/contacts/batch

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/contacts/batch" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Contacts Controller_find One

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

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

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

Contacts Controller_update Attributes

PATCH
/apps/{appId}/contacts/{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/contacts/string" \  -H "Content-Type: application/json" \  -d '{    "attributes": {      "firstName": "Jane",      "plan": "pro"    }  }'
Empty

Contacts Controller_remove

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

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

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

Contacts Controller_unsubscribe

PATCH
/apps/{appId}/contacts/{id}/unsubscribe

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X PATCH "https://example.com/apps/string/contacts/string/unsubscribe"
Empty

Contacts Controller_resubscribe

PATCH
/apps/{appId}/contacts/{id}/resubscribe

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X PATCH "https://example.com/apps/string/contacts/string/resubscribe"
Empty