Skip to content

Create or replace configuration for accessible lists

PUT /integrations/inxmail-professional/accessible-customers/{customerName}/configuration/accessible-lists

Creates or replaces a configuration concering Inxmail Professional lists (of the accessible customer) permissions for the space of the user. The configuration takes effect on "Retrieve a list of lists in Inxmail Professional" and "Create a Mailing Synchronization"

Request Parameters

Parameter Required In Description
customerName yes path The name of accessible customer

Payload Structure

Path Type Description Constraints
permittedLists Array<Number> List of Inxmail Professional list-ids which the space may access
permitAll Boolean Set true if the space may access all lists of the customer. Otherwise set false.

If permitAll is set to true all Inxmail Professional lists from the customer are permitted for the space of the current user. The permittedLists will be ignored.

By setting permitAll to false only the Inxmail Professional lists in permittedLists will be permitted for the space of the current user.

Response Structure

Path Type Description
permittedLists Array<Number> List of Inxmail Professional lists which the space is permitted
permitAll Boolean true if the space is permitted to access all Inxmail Professional lists

Basic example

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/accessible-customers/myka/configuration/accessible-lists' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Basic <base64Encoded user:password>' \
    -d '{ "permitAll": false, "permittedLists": [1,2,3,5,8,13]}'

Response:

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

{
    "permitAll": false,
    "permittedLists": [
        3,
        5,
        8,
        1,
        2
    ]
}