Update Event Settings for a Tenant

Update the notification settings of an event for a tenant.

Request URL

PUT {base_url}/uc-notification/api/v1/event-notification/event-types/{eventCode}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
eventCode Yes String The code of the event to update.
Note: You can obtain the event code using the Query Events for a Tenant interface.
Body parameters
Parameter Required Type Description
notificationEnabled No Boolean Whether notification for the event is enabled.
Valid value:
  • true: Enabled
  • false: Disabled

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

Example

Request example

PUT /uc-notification/api/v1/event-notification/event-types/INBOUND_CALL_REJECTED_STIR_SHAKEN HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDYwNzMxNywiaWF0IjoxNzkwNTg1NzE3LCJqdGkiOiIxNzZkY2NhMy1hNTYyLTQ2MzctYjU3Ny0yNzRiZTQ2Y2U4NDAiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.KPxN1ik0LSRbC1j4uU2OEYu4itse9qv3DVgCi_uFJvteI2b231kCk2iW-PRAA9rl_WwC7-_1sAjT6XUgwb_szdSbeSAyeerlEnYN0FFZf7AOnKgYj8I480i3lqcEXUOEtxLZJM7vAdPoXvCf_irwSlBOTcYTV1ZxFVpmamI39wUDnaw0J2GQlUo_yNiB1m1sFR6V8QmFz84ohcJGFfud9N6VwIS8NU618BH3dSnfri8HO9Ebv5qZ5WXDqGxto3wa-l5n3uqqUocDRe49-GG79Kv_bb3hoeVNzEe8DUUkEAX23X4vWTYvJwEjCatSvzKsW78qU7F1uib-mq6WEJfmUQ
Content-Type: application/json
x-tenant-code: jint
{
  
  "notificationEnabled": false
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "c11c2783e7a6faafe3b63d0ee11965fe",
  "code": "200",
  "message": "SUCCESS"
}