Skip to main content
PUT
/
v3
/
shares
/
{share}
Edit Share
curl --request PUT \
  --url http://localhost/api/v3/shares/{share} \
  --header 'Content-Type: application/json' \
  --data '
{
  "period": 123,
  "period_type": "days",
  "absolute_expiry": "<string>",
  "code": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "meta": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": 123,
    "profile_id": "<string>",
    "source_type": "<string>",
    "source_id": 123,
    "handle": "<string>",
    "code": "<string>",
    "timezone": "<string>",
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "expires_at": "<string>",
    "quantity": 123,
    "remaining_quantity": 123,
    "meta": [
      "<unknown>"
    ],
    "is_cloneable": true,
    "source": {},
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

share
integer
required

The share ID

Body

application/json
period
integer | null
period_type
enum<string> | null
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
absolute_expiry
string | null
code
string | null
Maximum string length: 255
expires_at
string<date-time> | null
meta
string[] | null

Response

Share

data
Share · object
required