About Topics

In the context of a DPS, a "topic" is used to organize and link related job orders, making it easier to keep track of and manage related tasks. The combination of a name and subject creates a unique topic, which allows job orders to be grouped and associated with each other.

This API is used to show the step-by-step process of creating topics.

URL Config

Endpoint: https://api.dps.io/api
APIVersion: v1
route: topics
path:
Method: POST 

Request Headers

{
    "Content-Type": "application/json",
    "x-api-key": "<YOUR_API_KEY>",
    "ShipperHash": "<YOUR_ShipperHash>",
}

Request Body

{
    "ShipperHash": "<Your Shipper Hash>",
    "Name": "name of your topic",
    "Subject": "subject of your topic"
}

Response

{
    "ShipperHash": "shipper",
    "Name": "name",
    "Subject": "subject",
    "Tags": "",
    "Stage": "stage",
    "CreatedDate": "",
    "LastModified": ""
}

Curl request

curl --location --request POST 'https://api.dps.io/api/v1/topics' \
--header 'x-api-key: <your-api-key>' \
--header 'ShipperHash: <your-shipper-hash>' \
--header 'Content-Type: application/json' \
--data-raw '{
                "ShipperHash": "EVa*****************sONq",
                "Name": "name of your topic",
                "Subject": "subject of your topic"
            }'