Create a Subscriber

Create a new subscriber in a specific list by submitting their email and any additional custom fields. A confirmation email will be triggered based on the list configuration.

🆕 Create a Subscriber

Add a subscriber to your list with custom field data such as email, first name, and last name.


🔹 HTTP Request

POST API-URL/lists/LIST-UNIQUE-ID/subscribers

🔸 URL Segments

Segment
Required
Description

LIST-UNIQUE-ID

Yes

List unique identifier.


📤 POST Parameters

Parameter
Type
Required
Description

data

array

Yes

Associative array with custom fields. EMAIL is mandatory.


🔐 Authorization Header

X-API-KEY: your-api-key-here

💻 PHP Example

// ADD SUBSCRIBER
$response = $endpoint->create('LIST-UNIQUE-ID', [
    'EMAIL'    => '[email protected]', // the confirmation email will be sent!!! Use valid email address
    'FNAME'    => 'Linda',
    'LNAME'    => 'Smith'
]);

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "record": {
      "subscriber_uid": "xy918k4tvd731",
      "email": "[email protected]",
      "ip_address": "192.168.25.101",
      "source": "api",
      "date_added": {
        "expression": "NOW()",
        "params": {}
      }
    }
  }
}

Last updated