Skip to main content

Unassign users from an orderlist

PATCH 
/v2/orderlists/:id/unassign-users

Unassign users from an orderlist

Request​

Path Parameters

    id integerrequired

    Orderlist identifier

    Example: 424242

Body

required

Users input

    userIds string[]required

    Default value: ``

    List of user ids

    userSources string[]

    List of user sources

Responses​

Users unassigned from orderlist

Schema

    id integerrequired

    Orderlist primary identifier

    createdAt date-timerequired

    Orderlist creation date

    lastModifiedAt date-timerequired

    Orderlist last modified date

    descriptions

    object[]

    required

    Orderlist description per language

  • Array [

    • language stringrequired

    Possible values: >= 2 characters and <= 2 characters

    Language is set as 2 character country code.

    value string

    Localized field value

  • ]

    • extras

    object[]

    Extra field per language

  • Array [

    • language stringrequired

    Possible values: >= 2 characters and <= 2 characters

    Language is set as 2 character country code.

    value string

    Localized field value

  • ]

    • code string

    Orderlist code

    validFrom date-time

    Valid from (Display only)

    validTo date-time

    Valid to (Display only)

    type stringrequired

    Possible values: [POSITIVE, NEGATIVE]

    Orderlist type

    partnerEntity string

    Partner entity

    active stringrequired

    Default value: Y

    Shows if the orderlist is active

    productIds string[]required

    List of product ids

    clusterIds string[]required

    List of cluster ids

    userIds string[]required

    List of user ids

    companyIds string[]required

    List of company ids

Loading...