personalizer.io Documentation

Help Page Home

POST v1/Collections?deleteUnlisted={deleteUnlisted}

Batch store (insert/update) collections.

Request Information

URI Parameters

NameTypeDescriptionComments
deleteUnlisted boolean

Whether or not collections that are not included in the request body should be deleted.

Optional - Default: false

Body Parameters

List of Collections to be stored in a batch.

Collection of Collection
NameTypeDescriptionComments
Identifier string

Collection's unique identifier in its source system.

Required

Title string

Title.

DisplayUrl string

Display URL.

ImageUrl string

Image URL.

Active boolean

Indicates if this collection is active or enabled.

Default is true

Prevalence integer

Collection prevalence set by the subscriber.

Value must be between -5 and 5

Request Formats

application/json, text/json

Sample:
[
  {
    "SubscriberID": 0,
    "Identifier": "sample string 1",
    "Title": "Apparels",
    "Published": false,
    "Active": true,
    "Prevalence": 0
  },
  {
    "SubscriberID": 0,
    "Identifier": "sample string 2",
    "Title": "Toys",
    "Published": false,
    "Active": true,
    "Prevalence": 0
  }
]

Response Information

Resource Description

A list of identifiers of collections that are modified (inserted, updated and deleted) by this operation.

Collection of IdentifierContainer
NameTypeDescriptionComments
Identifier string

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "Sample string 1"
  },
  {
    "Identifier": "Sample string 2"
  }
]