Create a new subscriber

POST

/api/subscribers

Create a new subscriber with the provided details

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.maildesk.io/api/subscribers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "tags": [
        "tag1",
        "tag2"
    ]
}'

Response Example

{
    "subscriber": {
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "email": "john.doe@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "status": "CONFIRMED",
        "tags": [
            "Newsletter",
            "Premium"
        ],
        "createdAt": "2024-03-20T10:00:00.000Z"
    }
}

Request

Body Params application/json

string

required

Email address of the contact

Example:

john.doe@example.com

firstName

string

required

First name of the contact

Example:

John

lastName

string

required

Last name of the contact

Example:

Doe

Responses

🟢201Created

application/json

Subscriber created successfully

Body

subscriber

object

required

Contact information

string

required

Unique identifier of the contact

Example:

01ARZ3NDEKTSV4RRFFQ69G5FAV

string

required

Email address of the contact

Example:

john.doe@example.com

firstName

string

required

First name of the contact

Example:

John

lastName

string

required

Last name of the contact

Example:

Doe

status

enum<string>

required

Subscription status of the contact

Allowed values:

CONFIRMEDUNSUBSCRIBEDUNCONFIRMEDPERMANENT_BOUNCE

Example:

CONFIRMED