Create list share

PUT

/api/v1/list-share

const url = 'https://example.com/api/v1/list-share';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"actor":"https://example.com","list":"example","permission":"view"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/list-share \
  --header 'Content-Type: application/json' \
  --data '{ "actor": "https://example.com", "list": "example", "permission": "view" }'

Creates a new list share. Converts ActivityPub actor IRI to ID

Request Body^required

application/json

object

actor

required

ActivityPub actor IRI

string format: uri

list

required

List ID (15 chars)

string

permission

required

string

Allowed values: view edit

Responses

201

List share created

application/json

object

required

Share ID (15 chars)

string

actor

required

ActivityPub actor IRI

string format: uri

list

required

List ID (15 chars)

string

permission

required

string

Allowed values: view edit

created

string format: date-time

updated

string format: date-time

Example

{
  "permission": "view"
}

400

Bad Request

500

Internal Server Error

Create list share

Request Body required

Responses

201

Example

400

500

Request Body^required