---
title: "POST /v1/workspaces/{workspaceId}/contacts"
method: POST
path: "/v1/workspaces/{workspaceId}/contacts"
---

# POST /v1/workspaces/{workspaceId}/contacts

`POST /v1/workspaces/{workspaceId}/contacts`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts`
- Auth: HTTP bearer

## Request body

- object
  - `email` string, email, required
  - `display_name` string
  - `status` 'subscribed' | 'unsubscribed' | 'bounced' | 'complained', required
  - `attributes` object
  - `consent_confirmed` boolean: Required when newly subscribing an address.

## Response `201`

Successful response.

- object
  - `data` Contact, required
    - `id` string, uuid, required
    - `email` string, email, required
    - `display_name` string, nullable, required
    - `attributes` object, required
    - `status` 'subscribed' | 'unsubscribed' | 'bounced' | 'complained', required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)