BlueAI Contacts
Manage and import mail delivery contacts.
|
Endpoints
| GET | /api/v1/mail/contacts | List contacts |
| POST | /api/v1/mail/contacts | Create a contact |
| GET | /api/v1/mail/contacts/{id} | Get a contact |
| PATCH | /api/v1/mail/contacts/{id} | Update a contact |
| DELETE | /api/v1/mail/contacts/{id} | Delete a contact |
| POST | /api/v1/mail/contacts/import | Import contacts |
GET
/api/v1/mail/contactsList contacts
Authentication required— Include session cookie or Bearer token
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | Optional | Search by name or email |
list_id | string | Optional | Filter by list ID |
status | string | Optional | Filter by status (active / unsubscribed / bounced) |
limit | integer | Optional | Number of items to return (default: 20, max: 100) |
offset | integer | Optional | Offset for pagination (default: 0) |
Code Examples
curl "https://api.blueai.jp/api/v1/mail/contacts" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/contactsCreate a contact
Authentication required— Include session cookie or Bearer token
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
email | string | Required | Email address |
first_name | string | Optional | First name |
last_name | string | Optional | Last name |
list_id | string | Optional | List ID to add to |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/mail/contacts" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/mail/contacts/{id}Get a contact
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Contact ID |
Code Examples
curl "https://api.blueai.jp/api/v1/mail/contacts/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/mail/contacts/{id}Update a contact
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Contact ID |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
email | string | Optional | Email address |
first_name | string | Optional | First name |
last_name | string | Optional | Last name |
Code Examples
curl -X PATCH "https://api.blueai.jp/api/v1/mail/contacts/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/mail/contacts/{id}Delete a contact
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Contact ID |
Code Examples
curl -X DELETE "https://api.blueai.jp/api/v1/mail/contacts/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/contacts/importImport contacts
Bulk import contacts from a CSV file.
Authentication required— Include session cookie or Bearer token
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/mail/contacts/import" \
-H "Cookie: better-auth.session_token=<token>"