personalizer.io Documentation

Help Page Home

POST v1/Collections

Batch store (insert/update) collections.

Request Information

URI Parameters

None.

Body Parameters

List of Collections to be stored in a batch.

Collection of Collection
NameTypeDescriptionComments
Identifier string

Title string

Type CollectionType

DisplayUrl string

ImageUrl string

Active boolean

Prevalence integer

Preferred boolean

Request Formats

application/json, text/json

Sample:
[
  {
    "SubscriberID": 0,
    "Identifier": "sample string 1",
    "Title": "Apparels",
    "Type": "Standard",
    "Published": false,
    "Active": true,
    "Prevalence": 0
  },
  {
    "SubscriberID": 0,
    "Identifier": "sample string 2",
    "Title": "Nike",
    "Type": "Brand",
    "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"
  }
]