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:
[
  {
    "ID": 1,
    "SubscriberID": 1,
    "Identifier": "sample string 2",
    "Title": "sample string 3",
    "Type": "Standard",
    "DisplayUrl": "sample string 4",
    "ImageUrl": "sample string 5",
    "Published": true,
    "Active": true,
    "Prevalence": 1,
    "Preferred": true,
    "Items": [
      1,
      2
    ],
    "ItemCount": 1,
    "VersionDate": "2021-07-27T20:35:02.7629043+00:00"
  },
  {
    "ID": 1,
    "SubscriberID": 1,
    "Identifier": "sample string 2",
    "Title": "sample string 3",
    "Type": "Standard",
    "DisplayUrl": "sample string 4",
    "ImageUrl": "sample string 5",
    "Published": true,
    "Active": true,
    "Prevalence": 1,
    "Preferred": true,
    "Items": [
      1,
      2
    ],
    "ItemCount": 1,
    "VersionDate": "2021-07-27T20:35:02.7629043+00:00"
  }
]

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"
  }
]