Subscribers

Start double opt-in for a new subscriber

Creates an immutable signup attempt and queues double opt-in mail delivery. Subscriber profile, tags, consent, automations and webhooks are deferred until confirmation.

post/subscribers/opt-in

Request

  • Base URL: https://api.maildroppa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.maildroppa.com/subscribers/opt-in
  • Auth: API key in header X-API-Key

Request body

emailstring
firstNamestring
tagsstring[]
gdprAgreementstring
consentSourcestring
topicIdsstring[]

Active topic ids the confirmed subscriber joins. Missing means the tenant default topic.

Example request

{
  "fields": [
    {
      "value": {
        "text": "Ann"
      }
    }
  ]
}

Response

Opt-in attempt recorded.

signupAttemptIdstring uuid
subscriberIdstring uuid
doubleOptInMailDecision'QUEUED' | 'CONFIRMATION_MAIL_ALREADY_SENT' | 'SUPPRESSED_ALREADY_SUBSCRIBED' | 'SUPPRESSED_COOLDOWN' | 'SUPPRESSED_SUBSCRIBER_LIMIT' | 'SUPPRESSED_CUSTOMER_LIMIT' | 'SUPPRESSED_SUBSCRIBER_POLICY'
confirmationExpiresAtUtcstring date-time

Example response

{
  "confirmationExpiresAtUtc": "2022-03-10T16:15:50Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.