---
title: "Opt-in a member"
method: POST
path: "/members/optins"
tags: ["Members"]
---

# Opt-in a member

`POST /members/optins`

Send an opt-in email to the specified email address, creating the member if not already existing
and adding them to the specified list of groups.

Warning: This method is throttled. If you use it in an online form, it is **strongly recommended**
to add a CAPTCHA to avoid abuse.

## Request body

- object
  - `email` string, email, required
  - `gender` string — m, f or o
  - `groups` string, required — CSV list of group IDs the member will be added to
  - `firstname` string
  - `lastname` string
  - `company` string
  - `language` string — en_ca or fr_ca
  - `birthdate` string — Format Y-m-d
  - `postalCode` string
  - `country` string
  - `note` string
  - `optinConfirmUrl` string — URL used as the opt-in confirmation page (format: http://www.example.com)
  - `customFields` object

## Response `201`

The ID of the opt-in request and its status

- object

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.net/cyberimpact/apis/cyberimpact-api.md) · [All operations](https://skmtc.net/cyberimpact/apis/cyberimpact-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cyberimpact/cyberimpact-api/revisions/bf0b51ee8e8a/schema)