Update a share

POST/api/share/id/{shareId}

Updates the specified share's name, slug, and parameters.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
shareIdrequired	string	Identifier used to access a shared resource.

Request body

Name	Type	Description
namerequired	string	Display name of the resource.
parametersrequired	object	Configuration parameters for the resource.
slugrequired	string	URL slug used to access the resource.

Example request

{
  "name": "string",
  "parameters": null,
  "slug": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
entityIdrequired	string	ID of the resource being shared.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

shareTyperequired	number	Type of resource made available by the share.
slugrequired	string	URL slug used to access the resource.
updatedAtrequired	string	Date and time the record was last updated.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "entityId": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "shareType": 0,
  "slug": "string",
  "updatedAt": "2024-01-15T09:30:00Z"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/share/id/{shareId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "parameters": null,
  "slug": "string"
}'

PreviousOpen a share by its slug NextGet active website visitors