Add recipient
rapidmail_create_recipientDestructive
WRITE: add ONE recipient (subscriber) to a recipient list. By default double opt-in is used: the recipient is created with status 'new' and rapidmail sends ONE confirmation e-mail to that address; they only receive newsletters after confirming. Set double_opt_in=false only if you hold the person's documented consent: the recipient is then stored as 'active' and no e-mail is sent (refused if the address was unsubscribed before). If a deleted recipient with the same address exists it is re-activated; an existing address returns a conflict error. Never use for bulk imports. POST /recipients.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | Postal code (max 7 characters). | |
| Yes | E-mail address of the recipient. | ||
| title | No | Academic title, e.g. Prof. Dr. | |
| extra1 | No | Custom field 1 (max 255 characters). | |
| extra2 | No | Custom field 2 (max 255 characters). | |
| extra3 | No | Custom field 3 (max 255 characters). | |
| extra4 | No | Custom field 4 (max 255 characters). | |
| extra5 | No | Custom field 5 (max 255 characters). | |
| extra6 | No | Custom field 6 (max 255 characters). | |
| extra7 | No | Custom field 7 (max 255 characters). | |
| extra8 | No | Custom field 8 (max 255 characters). | |
| extra9 | No | Custom field 9 (max 255 characters). | |
| gender | No | Gender. | |
| extra10 | No | Custom field 10 (max 255 characters). | |
| lastname | No | Last name. | |
| mailtype | No | Preferred mail format. | |
| birthdate | No | Birth date, yyyy-mm-dd. | |
| firstname | No | First name. | |
| test_mode | No | true: validate only, nothing is saved and no e-mail is sent. | |
| foreign_id | No | Your own external id for this contact. | |
| double_opt_in | No | true (default): status 'new' and a confirmation e-mail is sent to the address. false: status 'active', no e-mail (only with documented consent). | |
| recipientlist_id | Yes | rapidmail recipient list id to add the recipient to. |