Newsletter

Newsletter adjustments

Sign up for the newsletter. This will send a confirmation email with a validation url to follow.

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

emailstring · max: 128Required

Customer's email address

languagestringRequired

Customer's preferred language

Responses

204

No Content

No content

422

Unprocessable Entity

application/json

post

/v3/newsletter/optin

HTTPcURLJavaScriptPython

POST /v3/newsletter/optin HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "email": "text",
  "language": "text"
}

No content

Newsletter sign up confirmation, with the token from the confirmation email.

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

tokenstring · uuidRequired

The confirmation token from the opt-in email.

Responses

204

No Content

No content

404

Error

post

/v3/newsletter/confirm

HTTPcURLJavaScriptPython

POST /v3/newsletter/confirm HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "token": "123e4567-e89b-12d3-a456-426614174000"
}

No content

Unsubscribe from the newsletter, using the unsubscribe url in a newsletter.

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

mailhashstringRequired

A hash, as provided in the newsletter unsubscribe url

keystringRequired

A key, as provided in the newsletter unsubscribe url

Responses

204

No Content

No content

422

Unprocessable Entity

application/json

post

/v3/newsletter/unsubscribe

HTTPcURLJavaScriptPython

POST /v3/newsletter/unsubscribe HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "mailhash": "text",
  "key": "text"
}

No content