Destination next rates API

update values

PUT /api/rest/admin/routing/destination-next-rates/:id

Parameters

Name Description
data[type] Resource type (destinations-next-rates)
data[id] Destination next rate ID
data[attributes][next-rate] Next rate
data[attributes][initial-rate] Initial rate
data[attributes][initial-interval] Initial interval
data[attributes][next-interval] Next interval
data[attributes][connect-fee] Connect fee
data[attributes][apply-time] Apply time
data[attributes][applied] Applied
data[attributes][external-id] External id

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NTksInN1YiI6MTU4fQ.l0uokPGZOON-y_bMcahvhEJ3W0tymuWcdY1VH0JjBHc
Host: example.org
Cookie: 

Route

PUT /api/rest/admin/routing/destination-next-rates/5

Body

{"data":{"type":"destination-next-rates","id":5,"attributes":{"initial-rate":22}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"6e11d4e13b9afdad595f780f060ecdc7"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1f075150-4f0d-42f1-a7e5-2d943e65cfbf
X-Runtime: 0.016607
Content-Length: 564

Status

200 OK

Body

{
  "data": {
    "id": "5",
    "type": "destination-next-rates",
    "links": {
      "self": "http://example.org/api/rest/admin/routing/destination-next-rates/5"
    },
    "attributes": {
      "next-rate": "0.0",
      "initial-rate": "22.0",
      "initial-interval": 5,
      "next-interval": 10,
      "connect-fee": "0.0",
      "apply-time": "2024-11-14T10:55:59.519Z",
      "applied": false,
      "external-id": null
    },
    "relationships": {
      "destination": {
        "links": {
          "self": "http://example.org/api/rest/admin/routing/destination-next-rates/5/relationships/destination",
          "related": "http://example.org/api/rest/admin/routing/destination-next-rates/5/destination"
        }
      }
    }
  }
}