Sign in
latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Opt-in a member

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.

post/members/optins

Request body

emailstring email required
genderstring

m, f or o

groupsstring required

CSV list of group IDs the member will be added to

firstnamestring
lastnamestring
companystring
languagestring

en_ca or fr_ca

birthdatestring

Format Y-m-d

postalCodestring
countrystring
notestring
optinConfirmUrlstring

URL used as the opt-in confirmation page (format: http://www.example.com)

customFieldsobject

Example request

{
  "email": "testing@example.org",
  "gender": "f",
  "groups": "2554,65458,211238",
  "firstname": "Jane",
  "lastname": "Doe",
  "company": "Jane Doe Company inc",
  "language": "en_ca",
  "birthdate": "1980-12-04",
  "postalCode": "h1h1h1",
  "country": "CA",
  "note": "This is a test.",
  "optinConfirmUrl": "http://www.example.com",
  "customFields": {
    "1": "this is a test!",
    "2": 200,
    "3": 1.5,
    "4": "2000-01-01"
  }
}

Response

The ID of the opt-in request and its status

object required