Skip to main content

Bulk Links by lookup key

POST 

/links/bulk/:lookupKey

The bulk endpoints offer an efficient way of importing/updating large amounts of links with just a single API call. When using the bulk id endpoint, the link resources are identified by Propeller id. If a link for resources with such id doesn't already exist, it will be created. If it does exist, it will be updated.

When using the bulk sourceId endpoint, the link resources are identified by Propeller sourceId and source.

Fields

NameRequired
typeyes
subtypeyes
isDefaultno
Defaults to false
isActiveno
Defaults to true
fromyes
toyes
priorityno
Default to 0

Request

Path Parameters

    lookupKey stringrequired

    From and to resources lookup keys. id and sourceId are supported.

Body

    links

    object[]

  • Array [

  • from

    object

    class string
    language string
    source string
    sourceId string
    isActive boolean
    isDefault boolean
    subtype string

    to

    object

    class string
    language string
    source string
    sourceId string
    type string
  • ]

Responses

Bulk Links by Id - 200 / Bulk Links by Id - 200 (Product cross/upsell use case) / Bulk Links by sourceId - 200 (Product cross/upsell use case)

Response Headers

  • Connection

    string

  • Content-Length

    string

  • Date

    string

  • Keep-Alive

    string

  • Return-Format

    string

Schema

    data

    object[]

  • Array [

  • error string

    from

    object

    class string
    id number
    id number
    lookupKey string
    success boolean

    to

    object

    class string
    id number
  • ]

  • messages string[]
    total number
Loading...