Update auto publish

This endpoint updates auto publish.

URL : /config/auto-publish/{id}

Method : PATCH

X-HMAC required : YES

Request URL Parameters : {id}

Response

The response will be a JSON object containing updated auto publish.

interface AutoPublish {
    id: number;
    type: ALL | CUSTOMER;
    period: DAILY | MONTHLY | WEEKLY;
    time: number;
    customerId?: string;
    pendingLimit?: number;
    createdAt: Date;
    lastExec: Date;
    error?: boolean;
}

Status Codes

The endpoint will return the following status codes based on the operation outcome:

• 200OK: The request was successful.
• 400Bad Request: No data are published.
• 500Internal Server Error: An error occurred on the server while processing the request.

Example Request

PATCH /config/auto-publish/2 HTTP/1.1
Content-Type: application/json
Host: localhost:3000
X-HMAC: 5d41402abc4b2a76b9719d911017c592
{
    "type": "CUSTOMER",
    "period": "MONTHLY",
    "time": 4,
    "customerId": "2",
    "pendingLimit": 20
}

Example Response

{
    "id": 2,
    "type": "CUSTOMER",
    "period": "MONTHLY",
    "time": 4,
    "customerId": "2",
    "createdAt": "2024-03-13T10:03:08.834Z",
    "pendingLimit": 20,
    "lastExec": null,
    "error": null
}