1. Subscribers
Maildesk API
  • Maildesk Webhook
  • API Authentication
  • Subscribers
    • Create a new subscriber
      POST
    • Create up to 100 subscribers in a single request
      POST
    • Get a subscriber by ID
      GET
    • Delete a subscriber
      DELETE
    • Update a subscriber
      PUT
    • Get all subscribers
      GET
  • Tags
    • Get all tags
      GET
    • Create a new tag
      POST
    • Get a tag by ID
      GET
    • Update a tag
      PUT
    • Delete a tag
      DELETE
  • Custom Fields
    • List custom fields
      GET
    • Create a custom field
      POST
    • Update a custom field
      PUT
    • Delete a custom field
      DELETE
  • Schemas
    • Schemas
    • ContactApiResponse
    • CustomFieldDataType
    • UpdateContactAPIRequest
    • CreateCustomFieldRequest
    • PaginatedApiResponse
    • UpdateCustomFieldRequest
    • CreateContactAPIRequest
    • CustomField
    • PaginatedTagsApiResponse
    • BulkCreateContactAPIRequest
    • CustomFieldResponse
    • CreateTagApiRequest
    • BulkContactApiResponse
    • CustomFieldListResponse
    • TagApiResponse
    • CustomFieldValues
    • UpdateTagApiRequest
    • CreateSubscriberRequest
    • ContactResponseDto
    • BulkCreateSubscribersRequest
    • TagResponse
    • UpdateSubscriberRequest
    • Subscriber
    • BulkContactFailure
    • SubscriberResponse
    • BulkSubscriberFailure
    • BulkSubscribersResponse
    • Error
  1. Subscribers

Create a new subscriber

POST
/api/subscribers
Create a subscriber, optionally with custom field values.

Request

Authorization
Body Params application/jsonRequired

Examples

Responses

🟢201Created
application/json
Subscriber created
Bodyapplication/json

🟠409Unauthorized
🟠400InvalidCustomFields
🟠401Unauthorized
🟠403EmailNotVerified
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.maildesk.io/api/subscribers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "john.doe@yourcompany.com",
    "firstName": "John",
    "lastName": "Doe",
    "isConfirmed": true,
    "tags": [],
    "customFields": {
        "latest_destination": "Lisbon",
        "trips": 3
    }
}'
Response Response Example
201 - Example 1
{
    "subscriber": {
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "email": "john.doe@yourcompany.com",
        "firstName": "John",
        "lastName": "Doe",
        "status": "CONFIRMED",
        "tags": [
            "Newsletter"
        ],
        "customFields": {
            "latest_destination": "Lisbon",
            "trips": 3
        },
        "createdAt": "2026-10-07T10:00:00.000Z"
    }
}
Modified at 2026-10-08 06:32:39
Previous
API Authentication
Next
Create up to 100 subscribers in a single request
Built with