sharing lists
Rename a sharing list or replace its addresses
/api/v1/sharing-lists/{list_id}
Change the name, the addresses, or both. emails replaces the whole list of addresses.
key
Required scope: share
Path parameters
-
list_idinteger · requiredId of the sharing list.
Request body application/json
-
namestring or null · optionalNew name, 1 to 100 characters.
-
emailsarray of string or null · optionalThe addresses of the list, replacing the ones it had; 500 at most.
Response
200
SharingList
-
idintegerId of the list.
-
namestringName of the list.
-
scopestringWhether it is your own or belongs to the organisation.
-
emailsarray of stringIts 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-Aftergives the seconds to wait.