Update notification profile

This method allows you to update a notification profile. You can change its properties and provide an ID of security settings if you wish to change them.

Please log in to see full path URL. Learn why.
put
/subscriptions/1/profiles/{profileId}
path Parameters
profileId
required
string
Request Body schema:
application/json
collapse all -
webhook
object

Webhook configuration.

contentType
string [ 0 .. 255 ] characters
notifyUrl
required
string [ 0 .. 512 ] characters

Your webhook URL, where the notifications will be sent to.

security
object

Security settings object holding authentication settings necessary to access your webhook.

authId
required
string [ 1 .. 255 ] characters

Unique security setting ID. You can provide this ID if you want to associate your subscription with a different notification profile.

clientCertificateId
string [ 0 .. 255 ] characters

Client certificate ID.

maxBucketSize
integer <int32> [ 1 .. 2000 ]

Specifies a maximum number of messages to be sent within a single request.

windowSize
integer <int32> [ 20 .. 10000 ]

A maximum number of concurrent connections (active requests) per client.

connectTimeout
integer <int32> [ 300 .. 30000 ]

Time in milliseconds sender system waits for connection acknowledgement until the connection is closed.

readTimeout
integer <int32> [ 1000 .. 90000 ]

A maximum period of inactivity in milliseconds between two consecutive data packets.

enabledSSLProtocols
Array of strings
Items Enum: "TLSv1.2" "TLSv1.3"

Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.

headers
object

Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config.

property name*
string

Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config.

responseRegex
string

Response regex.

responseBodyRegex
string

Response body regex.

rateLimit
integer <int32> [ 1 .. 5000 ]

Limits the number of requests per second.

Responses

200

Success.

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not found.

429

Too many requests.

500

Internal Server Error

Request samples

Content type
application/json
Copy
Collapse all
{
  • "webhook":
    {},
  • "security":
    {
    • "authId": "AUTH-123"
    },
  • "maxBucketSize": 1,
  • "windowSize": 20,
  • "connectTimeout": 10000,
  • "readTimeout": 10000,
  • "enabledSSLProtocols":
    [
    • "TLSv1.3",
    • "TLSv1.2"
    ],
  • "headers":
    {
    • "X-Important-Header": "Important Value"
    },
  • "responseRegex": "[1-9][0-9]",
  • "responseBodyRegex": "[1-9][0-9]",
  • "rateLimit": 5000
}

Response samples

Content type
application/json
Copy
Collapse all
{
  • "profileId": "NOTIF-32395",
  • "security":
    {
    • "authId": "NEWAUTH-9291"
    }
}

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.