Modify an existing subscription

Testing Env

https://statimlogistics-test.dsapp.io/integration

PATCH

/api/v1/subscriptions/{subscriptionId}

Modify an existing subscription. Note that Basic Authentication is required for all requests
as such, make sure to provide the Authorization header with a valid value.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

subscriptionId

string

required

(Required)

Example:

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

text/plain

Body Params application/json

array of:

value

object

required

nullable

boolean

required

example

object

required

path

string

required

string

required

from

string

required

Example

[
  {
    "value": {
      "nullable": true,
      "example": {
        "error": [
          "Error message"
        ]
      }
    },
    "path": "<string>",
    "op": "<string>",
    "from": "<string>"
  },
  {
    "value": {
      "nullable": true,
      "example": {
        "error": [
          "Error message"
        ]
      }
    },
    "path": "<string>",
    "op": "<string>",
    "from": "<string>"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://statimlogistics-test.dsapp.io/integration/api/v1/subscriptions/<string>' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '[
  {
    "value": {
      "nullable": true,
      "example": {
        "error": [
          "Error message"
        ]
      }
    },
    "path": "<string>",
    "op": "<string>",
    "from": "<string>"
  },
  {
    "value": {
      "nullable": true,
      "example": {
        "error": [
          "Error message"
        ]
      }
    },
    "path": "<string>",
    "op": "<string>",
    "from": "<string>"
  }
]'

Responses

🟢200Subscription updated successfully

text/plain

Body

object {0}

Example

{
    "subscriptionId": "string",
    "entityType": "string",
    "entityId": "string",
    "targetUrl": "string",
    "eventTypes": "array",
    "accountId": "string"
}

🟠400Subscription update request has missing/invalid values

🟠404Subscription not found

🔴500An error occurred when trying to update the subscription

🟠401Unauthorized

Modified at 2025-02-27 10:28:48

Get a subscription

Unsubscribe from order updates