Developers API reference Version 1 · generated from the code openapi.json
Routes

sharing lists

Create a sharing list

POST /api/v1/sharing-lists

Create a list, personal or of the organisation (scope), optionally with its addresses. When the name is taken the list gets a numbered one.

Required scope: share

Request body application/json

  • name string · required

    Name, 1 to 100 characters.

  • scope string or null · optional

    personal or organisation. Left out: personal when the account has a personal space, of the organisation otherwise.

  • emails array of string or null · optional

    Its addresses, 500 at most.

Response

201 SharingList

  • id integer

    Id of the list.

  • name string

    Name of the list.

  • scope string

    Whether it is your own or belongs to the organisation.

  • emails array of string

    Its addresses, in alphabetical order.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 409

    The current state of the content forbids the request.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt