Mailmus

Contacts

Contacts_list

GET
/projects/{projectId}/contacts

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Query Parameters

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

Response Body

application/json

curl -X GET "https://example.com/projects/string/contacts?status=string&q=string&attrKey=string&attrValue=string"
{  "data": [    {      "id": "string",      "email": "contact@exemple.com",      "attributes": {},      "unsubscribed": true,      "appId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "pages": 0}

Contacts_create

POST
/projects/{projectId}/contacts

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/projects/string/contacts" \  -H "Content-Type: application/json" \  -d '{    "email": "contact@example.com"  }'
{  "id": "string",  "email": "contact@exemple.com",  "attributes": {},  "unsubscribed": true,  "appId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Contacts_export Csv

GET
/projects/{projectId}/contacts/export

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Response Body

text/csv

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

Contacts_import Csv

POST
/projects/{projectId}/contacts/import

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Response Body

application/json

curl -X POST "https://example.com/projects/string/contacts/import"
{  "imported": 0,  "skipped": 0}

Contacts_batch Import

POST
/projects/{projectId}/contacts/batch

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/projects/string/contacts/batch" \  -H "Content-Type: application/json" \  -d '{}'
{  "imported": 0,  "skipped": 0}

Contacts_find One

GET
/projects/{projectId}/contacts/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
projectId*string

Response Body

application/json

curl -X GET "https://example.com/projects/string/contacts/string"
{  "id": "string",  "email": "contact@exemple.com",  "attributes": {},  "unsubscribed": true,  "appId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Contacts_update Attributes

PATCH
/projects/{projectId}/contacts/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/projects/string/contacts/string" \  -H "Content-Type: application/json" \  -d '{    "attributes": {      "firstName": "Jane",      "plan": "pro"    }  }'
{  "id": "string",  "email": "contact@exemple.com",  "attributes": {},  "unsubscribed": true,  "appId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Contacts_remove

DELETE
/projects/{projectId}/contacts/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
projectId*string

Response Body

application/json

curl -X DELETE "https://example.com/projects/string/contacts/string"
{  "deleted": true}

Contacts_unsubscribe

PATCH
/projects/{projectId}/contacts/{id}/unsubscribe

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
projectId*string

Response Body

application/json

curl -X PATCH "https://example.com/projects/string/contacts/string/unsubscribe"
{  "id": "string",  "email": "contact@exemple.com",  "attributes": {},  "unsubscribed": true,  "appId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Contacts_resubscribe

PATCH
/projects/{projectId}/contacts/{id}/resubscribe

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
projectId*string

Response Body

application/json

curl -X PATCH "https://example.com/projects/string/contacts/string/resubscribe"
{  "id": "string",  "email": "contact@exemple.com",  "attributes": {},  "unsubscribed": true,  "appId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}