Skip to main content
POST
/
v3
/
shares
Add Share
curl --request POST \
  --url http://localhost/api/v3/shares \
  --header 'Content-Type: application/json' \
  --data '
{
  "profile_id": "<string>",
  "source_id": 123,
  "source_type": "profile",
  "code": "<string>",
  "timezone": "<string>",
  "period": 123,
  "period_type": "days",
  "absolute_expiry": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "remaining_quantity": 123,
  "quantity": "1",
  "meta": [
    "<string>"
  ],
  "is_cloneable": true
}
'
{
  "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.

Body

application/json
profile_id
string
required
source_id
integer
required
source_type
enum<string>
required
Available options:
profile,
product,
transaction,
reward,
benefit,
point,
user,
tenant,
list,
listItem,
target,
automation,
trigger,
aggregation,
comms_attribute,
appearance_attribute,
webhook,
identity,
tier,
address,
location,
product_variant,
benefit_definition,
reward_definition,
tier_definition,
transaction_item,
order,
redemption,
tier_point,
interaction,
status,
organisation,
role_definition,
credit_definition,
credit,
product_list_reservation
code
string | null
timezone
string | null
period
integer | null
period_type
enum<string> | null
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
absolute_expiry
string | null
expires_at
string<date-time> | null
remaining_quantity
integer | null
quantity
enum<integer>
Available options:
1
Required range: x >= 1
meta
string[] | null
is_cloneable
boolean

Response

Share

data
Share · object
required