Skip to main content
PUT
/
v3
/
rates
/
{rate}
Edit Rate
curl --request PUT \
  --url https://api.{tenant}.getomneo.com/api/v3/rates/{rate} \
  --header 'Content-Type: application/json' \
  --data '
{
  "handle": "<string>",
  "type": "<string>",
  "location": "<string>",
  "code": "<string>",
  "name": "<string>",
  "rate": 123,
  "is_default": true,
  "region_id": 123,
  "location_id": 123,
  "country_iso_2": "<string>",
  "profile_conditions": [
    "<string>"
  ],
  "product_conditions": [
    "<string>"
  ],
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "issue_period": 123,
  "issue_absolute_expiry": "<string>",
  "earn_instructions": "<string>",
  "internal_notes": "<string>",
  "is_published": true,
  "priority": 123
}
'
{
  "data": {
    "id": 123,
    "handle": "<string>",
    "type": "<string>",
    "location": "<string>",
    "code": "<string>",
    "name": "<string>",
    "rate": "<string>",
    "is_default": true,
    "is_archived": true,
    "region_id": 123,
    "region": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>"
    },
    "location_id": 123,
    "location_object": {
      "id": "<string>",
      "name": "<string>",
      "handle": "<string>"
    },
    "country_iso_2": "<string>",
    "profile_conditions": [
      "<unknown>"
    ],
    "product_conditions": [
      "<unknown>"
    ],
    "start_time": "<string>",
    "end_time": "<string>",
    "issue_period": 123,
    "issue_period_type": "<string>",
    "issue_absolute_expiry": "<string>",
    "earn_instructions": "<string>",
    "internal_notes": "<string>",
    "is_published": true,
    "priority": 123,
    "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

​
rate
integer
required

The rate ID

Body

application/json
​
handle
string
​
type
string
​
location
string | null
​
code
string | null
​
name
string | null
​
rate
number
​
is_default
boolean | null
​
region_id
integer | null
​
location_id
integer | null
​
country_iso_2
string | null
Required string length: 2
​
profile_conditions
string[] | null
​
product_conditions
string[] | null
​
start_time
string<date-time> | null
​
end_time
string<date-time> | null
​
issue_period
integer | null
​
issue_period_type
enum<string> | null
Available options:
hours,
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
​
issue_absolute_expiry
string | null
​
earn_instructions
string | null
​
internal_notes
string | null
​
is_published
boolean | null
​
priority
integer | null

Response

Rate

​
data
Rate · object
required