latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Add a new member

Add a new member in your account. If you need the member to confirm their subscription, it is recommended that you use the opt-in endpoint instead.

If you use this method in an online form, it is strongly recommended to add a CAPTCHA to avoid abuse.

Warning: This method is throttled. If you wish to use it for synchronization purposes between two systems, please contact us. If you need to add multiple members at once, use the batches endpoint.

post/members

Request body

emailstring email required
genderstring

m, f or o

groupsstring

CSV list of group IDs to subscribe the member to

firstnamestring
lastnamestring
companystring
languagestring

en_ca or fr_ca

birthdatestring

Format Y-m-d

postalCodestring
countrystring

ISO 3166-1 alpha-2 country code

notestring
customFieldsobject

Keys are string IDs of custom fields. Values can be string, integer, or decimal number.

Example request

{
  "email": "testing@example.org",
  "gender": "m",
  "groups": "123,34565,56757,34",
  "firstname": "John",
  "lastname": "Doe",
  "company": "John Doe Company inc",
  "language": "en_ca",
  "birthdate": "1980-12-04",
  "postalCode": "h1h1h1",
  "country": "CA",
  "note": "This is a test.",
  "customFields": {
    "1": "this is a test!",
    "2": 200,
    "3": 1.5,
    "4": "2000-01-01"
  }
}

Response

Attributes of the newly created member

idinteger
firstnamestring
lastnamestring
companystring
emailstring email
genderstring

m, f or o

languagestring

en_ca or fr_ca

joinedOnstring nullable
updatedOnstring nullable
consentTypestring
postalCodestring
countrystring

ISO 3166-1 alpha-2 country code

notestring
birthdatestring nullable
mailingsReceivedinteger
mailingsOpenedinteger
mailingsClickedinteger
customFieldsobject

Example response

{
  "id": 3664823,
  "firstname": "John",
  "lastname": "Doe",
  "company": "John Doe Company inc",
  "email": "john.doe@example.org",
  "gender": "m",
  "language": "fr_ca",
  "joinedOn": "2014-12-09 13:42:48.020",
  "updatedOn": "2014-12-10 12:41:42.020",
  "consentType": "implied",
  "country": "CA",
  "customFields": {
    "1": "This is a test !",
    "2": 1000,
    "3": 1.5,
    "4": "2000-01-01"
  }
}