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

sharing lists

Rename a sharing list or replace its addresses

PATCH /api/v1/sharing-lists/{list_id}

Change the name, the addresses, or both. emails replaces the whole list of addresses.

Required scope: share

Path parameters

  • list_id integer · required

    Id of the sharing list.

Request body application/json

  • name string or null · optional

    New name, 1 to 100 characters.

  • emails array of string or null · optional

    The addresses of the list, replacing the ones it had; 500 at most.

Response

200 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.

  • 404

    Nothing with that id, or nothing the account may open.

  • 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