API ReferenceView as MarkdownOpenAPI

Leads & forms

View as Markdown

Leads are the enquiries visitors send - contact forms, custom forms and lead forms on pages - with where they came from.

Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.

30 endpoints in 6 parts: Custom Form, Form, Lead, Newsletter Contact, Price Quote, Unsubscribed.

List all custom forms

Returns the site's custom forms, newest first unless a sort is given.

Admin token

Needs a site admin token.

Returns

Returns a list of CustomForm objects.

Status codes

200 401 500

GET/custom_forms
curl -X GET 'http://nd.max-media.io/custom_forms?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "obj": {},
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z"
  }
]

Retrieve a custom form

Returns one custom form, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the custom form.

Returns

Returns the CustomForm object.

Status codes

200 401 404 500

GET/custom_forms/:id
curl -X GET 'http://nd.max-media.io/custom_forms/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "obj": {},
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update a custom form

Update CustomForm by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the custom form.

Returns

Returns the CustomForm object.

Status codes

200 400 401 404 500

PATCH/custom_forms/:id
curl -X PATCH 'http://nd.max-media.io/custom_forms/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "obj": {},
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete a custom form

Delete CustomForm record by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the custom form.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/custom_forms/:id
curl -X DELETE 'http://nd.max-media.io/custom_forms/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

List all forms

Returns the site's forms, newest first unless a sort is given.

Admin token

Needs a site admin token.

Returns

Returns a list of Form objects.

Status codes

200 401 500

GET/forms
curl -X GET 'http://nd.max-media.io/forms?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "name": "Example",
    "email": "jane@example.com",
    "subject": "example",
    "body": "Text shown on the site.",
    "medias": [],
    "additional": [
      {
        "title": "Example",
        "option": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z"
  }
]

Create a form

Create new form.

reCAPTCHA

Needs a reCAPTCHA token from the site form.

Parameters
bodystring

The form's body.

emailstring

An email address.

Returns

Returns the Form object.

Status codes

200 400 500

POST/forms
curl -X POST 'http://nd.max-media.io/forms?ionic=true' \
  -H 'Content-Type: application/json' \
  -d '{ "body": "...", "email": "..." }'
Response
{
  "name": "Example",
  "email": "jane@example.com",
  "subject": "example",
  "body": "Text shown on the site.",
  "medias": [],
  "additional": [
    {
      "title": "Example",
      "option": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve a form

Returns one form, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the form.

Returns

Returns the Form object.

Status codes

200 401 404 500

GET/forms/:id
curl -X GET 'http://nd.max-media.io/forms/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "email": "jane@example.com",
  "subject": "example",
  "body": "Text shown on the site.",
  "medias": [],
  "additional": [
    {
      "title": "Example",
      "option": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update a form

Update Form by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the form.

Returns

Returns the Form object.

Status codes

200 400 401 404 500

PATCH/forms/:id
curl -X PATCH 'http://nd.max-media.io/forms/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "email": "jane@example.com",
  "subject": "example",
  "body": "Text shown on the site.",
  "medias": [],
  "additional": [
    {
      "title": "Example",
      "option": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete a form

Delete Form record by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the form.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/forms/:id
curl -X DELETE 'http://nd.max-media.io/forms/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

List all leads

Returns the site's leads, newest first unless a sort is given.

Admin token

Needs a site admin token.

Returns

Returns a list of Lead objects.

Status codes

200 401 500

GET/leads
curl -X GET 'http://nd.max-media.io/leads?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "seq": 0,
    "organization_name": "Example",
    "firstname": "Example",
    "lastname": "Example",
    "email": "jane@example.com",
    "phone_number": "+359 888 123 456",
    "address": "example",
    "city": "example",
    "state": "example",
    "country": "example",
    "zip_code": "example",
    "tax_identification_number": "example",
    "vat_id": "example",
    "notes": "Text shown on the site.",
    "products": [
      "example"
    ],
    "products_obj": [
      {
        "product_id": "6543210fedcba98765432100",
        "name": "Example",
        "options": "example",
        "price": 49.9,
        "quantity": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "programs": [
      "example"
    ],
    "programs_obj": [
      {
        "program_id": "6543210fedcba98765432100",
        "title": "Example",
        "price": 49.9,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "tickets": [
      "6543210fedcba98765432101"
    ],
    "donations": [
      "6543210fedcba98765432101"
    ],
    "donations_obj": [
      {
        "donation_id": "6543210fedcba98765432100",
        "name": "Example",
        "options": "example",
        "price": 49.9,
        "quantity": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "lifetime_value": 0,
    "last_order_value": 49.9,
    "services": [
      "6543210fedcba98765432101"
    ]
  }
]

Create a lead

Creates a lead from the fields sent.

Public

Public - no token needed.

Parameters
owner_idstring

The lead's owner id.

splitstring

The lead's split.

emailstring

An email address.

phone_numberstring

The lead's phone number.

organization_namestring

The lead's organization name.

firstnamestring

The lead's firstname.

lastnamestring

The lead's lastname.

addressstring

The lead's address.

citystring

The lead's city.

statestring

The lead's state.

countrystring

The lead's country.

zip_codestring

The lead's zip code.

tax_identification_numberstring

The lead's tax identification number.

notesstring

The lead's notes.

ticketsobjectid[]

The tickets - the ID of a ticket.

productsstring[]

The lead's products.

programsstring[]

The lead's programs.

donationsobjectid[]

The donations - the ID of a donation.

newsletterstring

The lead's newsletter.

namestring

The lead's name.

agestring

The lead's age.

products_objobject[]

The lead's products obj.

programs_objobject[]

The lead's programs obj.

valuestring

The lead's value.

donations_strstring

The lead's donations str.

Returns

Returns the Lead object.

Status codes

200 400 500 503

POST/leads
curl -X POST 'http://nd.max-media.io/leads?ionic=true' \
  -H 'Content-Type: application/json' \
  -d '{ "owner_id": "...", "split": "...", "email": "...", "phone_number": "...", "organization_name": "..." }'
Response
{
  "seq": 0,
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "vat_id": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "lifetime_value": 0,
  "last_order_value": 49.9,
  "services": [
    "6543210fedcba98765432101"
  ]
}

Retrieve a lead

Returns one lead, found by its ID.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the lead.

Returns

Returns the Lead object.

Status codes

200 404 500

GET/leads/:id
curl -X GET 'http://nd.max-media.io/leads/{id}?ionic=true'
Response
{
  "seq": 0,
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "vat_id": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "lifetime_value": 0,
  "last_order_value": 49.9,
  "services": [
    "6543210fedcba98765432101"
  ]
}

Update a lead

Changes the fields sent; the others stay as they are.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the lead.

Returns

Returns the Lead object.

Status codes

200 400 401 404 500

PATCH/leads/:id
curl -X PATCH 'http://nd.max-media.io/leads/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "seq": 0,
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "vat_id": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "lifetime_value": 0,
  "last_order_value": 49.9,
  "services": [
    "6543210fedcba98765432101"
  ]
}

Delete a lead

Deletes the lead. This cannot be undone.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the lead.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/leads/:id
curl -X DELETE 'http://nd.max-media.io/leads/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

List all newsletter contacts

Returns the site's newsletter contacts, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Returns

Returns a list of NewsletterContact objects.

Status codes

200 401 500

GET/newsletter_contacts
curl -X GET 'http://nd.max-media.io/newsletter_contacts?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "name": "Example",
    "age": 1,
    "email": "jane@example.com",
    "city": "example",
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z"
  }
]

Create a newsletter contact

Create new newsletter_contact.

reCAPTCHA

Needs a reCAPTCHA token from the site form.

Parameters
namestring

The newsletter contact's name.

emailstring

An email address.

agenumber

The newsletter contact's age.

citystring

The newsletter contact's city.

Returns

Returns the NewsletterContact object.

Status codes

200 400 500

POST/newsletter_contacts
curl -X POST 'http://nd.max-media.io/newsletter_contacts?ionic=true' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "...", "email": "...", "age": "...", "city": "..." }'
Response
{
  "name": "Example",
  "age": 1,
  "email": "jane@example.com",
  "city": "example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve a newsletter contact

Returns one newsletter contact, found by its ID.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the newsletter contact.

Returns

Returns the NewsletterContact object.

Status codes

200 401 404 500

GET/newsletter_contacts/:id
curl -X GET 'http://nd.max-media.io/newsletter_contacts/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "age": 1,
  "email": "jane@example.com",
  "city": "example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update a newsletter contact

Update NewsletterContact by id.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the newsletter contact.

Returns

Returns the NewsletterContact object.

Status codes

200 400 401 404 500

PATCH/newsletter_contacts/:id
curl -X PATCH 'http://nd.max-media.io/newsletter_contacts/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "age": 1,
  "email": "jane@example.com",
  "city": "example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete a newsletter contact

Delete NewsletterContact record by id.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the newsletter contact.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/newsletter_contacts/:id
curl -X DELETE 'http://nd.max-media.io/newsletter_contacts/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Retrieve a download price quote

Download price quote pdf.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the download price quote.

translatestringRequired

The download price quote's translate.

filenamestringRequired

The download price quote's filename.

Status codes

200 400 500

GET/download-price-quote/:id/:translate/:filename
curl -X GET 'http://nd.max-media.io/download-price-quote/{id}/{translate}/{filename}?ionic=true'

Retrieve the price quote

Returns the price quote.

Admin token

Needs a site admin token.

Returns

Returns the PriceQuote object.

Status codes

200 401 500

GET/price-quote
curl -X GET 'http://nd.max-media.io/price-quote?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "customer_name": "Example",
  "customer_address": "example",
  "customer_postal_code": "example",
  "customer_city": "example",
  "customer_country": "example",
  "customer_phone": "+359 888 123 456",
  "customer_email": "jane@example.com",
  "customer_tax_id": "example",
  "customer_vat_id": "example",
  "customer_responsible_official": "example",
  "customer_organization_name": "Example",
  "billing_customer_address": "example",
  "billing_customer_postal_code": "example",
  "billing_customer_city": "example",
  "billing_customer_country": "example",
  "billing_customer_phone": "+359 888 123 456",
  "subtotal": 49.9,
  "amount": 49.9,
  "day_of_issue": "example",
  "number": 1,
  "foreign": false,
  "home_tax": 0,
  "foreign_tax": 0,
  "items": [
    {
      "id": "example",
      "name": "Example",
      "qty": 1,
      "unit_price": 49.9,
      "discount": 1,
      "amount": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "invoice_settings": {
    "number": 0,
    "price_quote_number": "example",
    "bic": "example",
    "swift": "example",
    "tax_id": "example",
    "vat_id": "example",
    "logo": "example",
    "business_name": "Example",
    "business_name_translated": "Example",
    "responsible_official": "example",
    "responsible_official_translated": "example",
    "business_email": "jane@example.com"
  }
}

Create a price quote

Create new price quote.

Admin token

Needs a site admin token.

Parameters
sendstring

The price quote's send.

Returns

Returns the PriceQuote object.

Status codes

201 400 401 500

POST/price-quote
curl -X POST 'http://nd.max-media.io/price-quote?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "send": "..." }'
Response
{
  "customer_name": "Example",
  "customer_address": "example",
  "customer_postal_code": "example",
  "customer_city": "example",
  "customer_country": "example",
  "customer_phone": "+359 888 123 456",
  "customer_email": "jane@example.com",
  "customer_tax_id": "example",
  "customer_vat_id": "example",
  "customer_responsible_official": "example",
  "customer_organization_name": "Example",
  "billing_customer_address": "example",
  "billing_customer_postal_code": "example",
  "billing_customer_city": "example",
  "billing_customer_country": "example",
  "billing_customer_phone": "+359 888 123 456",
  "subtotal": 49.9,
  "amount": 49.9,
  "day_of_issue": "example",
  "number": 1,
  "foreign": false,
  "home_tax": 0,
  "foreign_tax": 0,
  "items": [
    {
      "id": "example",
      "name": "Example",
      "qty": 1,
      "unit_price": 49.9,
      "discount": 1,
      "amount": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "invoice_settings": {
    "number": 0,
    "price_quote_number": "example",
    "bic": "example",
    "swift": "example",
    "tax_id": "example",
    "vat_id": "example",
    "logo": "example",
    "business_name": "Example",
    "business_name_translated": "Example",
    "responsible_official": "example",
    "responsible_official_translated": "example",
    "business_email": "jane@example.com"
  }
}

Retrieve a price quote

Returns one price quote, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the price quote.

Returns

Returns the PriceQuote object.

Status codes

200 401 404 500

GET/price-quote/:id
curl -X GET 'http://nd.max-media.io/price-quote/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "customer_name": "Example",
  "customer_address": "example",
  "customer_postal_code": "example",
  "customer_city": "example",
  "customer_country": "example",
  "customer_phone": "+359 888 123 456",
  "customer_email": "jane@example.com",
  "customer_tax_id": "example",
  "customer_vat_id": "example",
  "customer_responsible_official": "example",
  "customer_organization_name": "Example",
  "billing_customer_address": "example",
  "billing_customer_postal_code": "example",
  "billing_customer_city": "example",
  "billing_customer_country": "example",
  "billing_customer_phone": "+359 888 123 456",
  "subtotal": 49.9,
  "amount": 49.9,
  "day_of_issue": "example",
  "number": 1,
  "foreign": false,
  "home_tax": 0,
  "foreign_tax": 0,
  "items": [
    {
      "id": "example",
      "name": "Example",
      "qty": 1,
      "unit_price": 49.9,
      "discount": 1,
      "amount": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "invoice_settings": {
    "number": 0,
    "price_quote_number": "example",
    "bic": "example",
    "swift": "example",
    "tax_id": "example",
    "vat_id": "example",
    "logo": "example",
    "business_name": "Example",
    "business_name_translated": "Example",
    "responsible_official": "example",
    "responsible_official_translated": "example",
    "business_email": "jane@example.com"
  }
}

Delete a price quote

Delete PriceQuote record by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the price quote.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/price-quote/:id
curl -X DELETE 'http://nd.max-media.io/price-quote/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Retrieve the unsubscribe

Returns the unsubscribe.

Optional user

Works without a token; with a user token the answer is personal.

Status codes

200

GET/unsubscribe
curl -X GET 'http://nd.max-media.io/unsubscribe?ionic=true'

Retrieve the unsubscribed

Returns the unsubscribed.

Admin token

Needs a site admin token.

Returns

Returns the Unsubscribed object.

Status codes

200 401 500

GET/unsubscribed-list
curl -X GET 'http://nd.max-media.io/unsubscribed-list?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "email": "jane@example.com",
  "_id": "6543210fedcba98765432100"
}

Create an unsubscribed

Create new unsubscribed.

Public

Public - no token needed.

Parameters
emailstring

An email address.

Returns

Returns the Unsubscribed object.

Status codes

201 400 409 500

POST/unsubscribed-list
curl -X POST 'http://nd.max-media.io/unsubscribed-list?ionic=true' \
  -H 'Content-Type: application/json' \
  -d '{ "email": "..." }'
Response
{
  "email": "jane@example.com",
  "_id": "6543210fedcba98765432100"
}

Retrieve an unsubscribed

Returns one unsubscribed, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the unsubscribed.

Returns

Returns the Unsubscribed object.

Status codes

200 401 404 500

GET/unsubscribed-list/:id
curl -X GET 'http://nd.max-media.io/unsubscribed-list/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "email": "jane@example.com",
  "_id": "6543210fedcba98765432100"
}

Update an unsubscribed

Update Unsubscribed by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the unsubscribed.

Returns

Returns the Unsubscribed object.

Status codes

200 400 401 404 500

PATCH/unsubscribed-list/:id
curl -X PATCH 'http://nd.max-media.io/unsubscribed-list/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "email": "jane@example.com",
  "_id": "6543210fedcba98765432100"
}

Delete an unsubscribed

Delete Unsubscribed record by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the unsubscribed.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/unsubscribed-list/:id
curl -X DELETE 'http://nd.max-media.io/unsubscribed-list/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
↑↓ Navigate↵ GoEsc Close