PRpromorepublic
Collection Management

Create a collection

Create a new collection managed by the current API user. If the user specifies a set of locations for the collections, users managing the whole set of locations can also manage the collection.

post/collections

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Request body

idinteger

Collection id

identifierstring required

Mandatory - A unique identifier for the collection

namestring required

Mandatory - Name of the content collection

descriptionstring

A description of the collection

type'MENU' | 'PEOPLE' | 'PRODUCTS' | 'CUSTOM' | 'SERVICES' | 'EVENTS' | 'FAQ' required

Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM

locationIdsinteger[]

Location Ids that should be associated with this collection

isReadOnlyboolean

Special field for FE indicating if the collection is read-only for the logged in user

cuisineType'AMERICAN' | 'ASIAN' | 'BRAZILIAN' | 'BREAKFAST' | 'BRUNCH' | 'CHICKEN' | 'CHINESE' | 'FAMILY' | 'FAST_FOOD' | 'FRENCH' | 'GREEK' | 'GERMAN' | 'HAMBURGER' | 'INDIAN' | 'INDONESIAN' | 'ITALIAN' | 'JAPANESE' | 'KOREAN' | 'LATIN_AMERICAN' | 'MEDITERRANEAN' | 'MEXICAN' | 'PAKISTANI' | 'PIZZA' | 'SEAFOOD' | 'SPANISH' | 'SUSHI' | 'THAI' | 'TURKISH' | 'VEGETARIAN' | 'VIETNAMESE' | 'OTHER_CUISINE'

Only applicable to Menu content collections - indicates the cuisine the restaurant serves

urlstring

Applicable to Menu collections only - url to the brand webpage menu

Example request

{
  "contentLists": [
    {
      "title": "Lunch Menu",
      "items": [
        {
          "category": "Starters, Drinks, Desert, etc."
        }
      ]
    }
  ]
}

Response

Collection created

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "collection": {
      "contentLists": [
        {
          "title": "Lunch Menu",
          "items": [
            {
              "category": "Starters, Drinks, Desert, etc."
            }
          ]
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.