---
title: "Add contacts to an unsubscribe group"
method: POST
path: "/v1/unsubscribe-groups/{id}/members"
tags: ["Unsubscribe Groups"]
---

# Add contacts to an unsubscribe group

`POST /v1/unsubscribe-groups/{id}/members`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/unsubscribe-groups/{id}/members`
- Auth: API key in header `x-api-key`

Moves contacts out of an unsubscribe group's audience and returns the number added and the number skipped. Leaving a group stops that group's sends to the contact on every channel. Each member is a contact ID, an email address, or a phone number; an address no contact holds gets a new contact, so an import from another email service needs no contacts first.

## Path parameters

- `id` string, required

## Request body

- object
  - `members` UnsubscribeGroupMemberRef[], required
    - union
      - UnsubscribeGroupMemberByContact
        - `contactId` string, required
      - UnsubscribeGroupMemberByEmail
        - `email` string, required
      - UnsubscribeGroupMemberByPhone
        - `phone` string, required
  - `source` 'link' | 'api' | 'manual' | 'complaint', nullable

## Response `200`

Success

- object
  - `added` integer, required
  - `skipped` integer, required

## Other responses

- `401`: UnauthorizedError
- `402`: PaymentRequiredError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `422`: ValidationError
- `500`: InternalError
- `502`: BillingProviderError
- `504`: GatewayTimeoutError

---

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