Swift API Sandbox Collections API Documentation
Update existing subscription.
PUT {{baseUrl}}/subscriptions/{{subscription-id}}
A client can invoke this API when they want to update an existing subscription they own. Common parameters that can be updated for a subscription through any channel are recipientinstitution /batchsizemax/expiration/description. In addition to this list , parameters that can be updated for ; webhook – webhookurl, email - emails and SMS – mobile_numbers .
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
notif-role
|
string | (Required) Header that identifies role of the requester to validate if its a provider or consumer. Added by the client in the request. | |
Content-Type
|
string |
RESPONSES
status OK
| {
"recipient_institution": [
"CITIUS33",
"CITIGB22"
],
"service_name": "GPI",
"category": "gCASE",
"expiration": "2018-12-07T17:58:31.357Z",
"batch_size_max": 10,
"description": "GPI subscription"
} |
Curl
curl -X PUT 'https://sandbox.swift.com/swift-notif/v1/subscriptions/subscription-id' -H 'notif-role: Y29uc3VtZXI=' -H 'Content-Type: application/json' -d '{"recipient_institution":["GPIIUS22"],"emails":[""],"expiration":"2021-12-27T17:40:30.000Z","webhook_url":"","batch_size_max":10,"description":"Updating the batch size"}'
ENDPOINTS