Skip to content

Last changes in distribution list

Request

Endpoint is intended to determine the changes after you load the complete e-mail list and you need to know if any of these e-mails were added or removed. Guaranteed history is 30 days, the older data are deleted progressively.

Each e-mail on single e-mail list is only mentioned with its last change, within the log. For example, if the e-mail is deleted and then added again, the log will only show information about its addition. The e-mail lists are not dependant on each other (removing an e-mail from one list does not cause any change in another list, unless the e-mail was originally included in both).

Can be filtered by changeType = edit/delete parameter.

For "created" action, we use edit change type.

Endpoint supports Paging.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired

e-mail list code

Example:newsletters
Query
fromstringrequired

DateTime from which up to the present we are interested in the changes. + in the time zone

Example:from=2018-01-01T01:01:01+02:00
changeTypestring

Returning only edit or delete type changed records

Example:changeType=edit
itemsPerPageinteger

Returned items per page. Default and max value is 500.

Example:itemsPerPage=400
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/mailing-lists/newsletters/changes?from=2018-01-01T01%3A01%3A01%2B02%3A00&changeType=edit&itemsPerPage=400&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "changes": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}