Update subscription

This method allows you to update the subscription. You can change its properties and provide an ID of a profile if you wish to change it.

Please log in to see full path URL. Learn why.

put

/subscriptions/1/subscription/{channel}/{subscriptionId}

Authorizations:

Scopes:

subscriptions:manage

path Parameters

subscriptionId required	string ID of the subscription you want to modify.
channel required	string Enum: "BLOCKLIST" "CUSTOMER_ENGAGEMENT" "EMAIL" "FACEBOOK" "KAKAO_ALIM" "KAKAO_CHINGU" "LINE" "MMS" "MOBILE_IDENTITY" "MOBILE_PUSH" "NUMBER_LOOKUP" "OPEN_CHANNEL" "RCS" "REGISTRATION" "SMS" "VIBER" "VOICE_VIDEO" "WHATSAPP" "ZALO" Channel name. A separate subscription is needed for each channel.

Request Body schema:

application/json

collapse all -

One of

Blocklist
Customer Engagement
Email
Facebook
Kakao Alim
Kakao Chingu
Line
MMS
Mobile Identity
Mobile Push
Number Lookup
Open Channel
RCS
Registration
SMS
Viber
Voice and Video
Whatsapp
Zalo

Subscription group.

name

string [ 1 .. 255 ] characters

Subscription group name.

profile

required

object

Notification profile object holding settings for your webhook URL and a reference to security settings.

profileId

required

string [ 1 .. 255 ] characters

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

events

required

Array of strings [ 0 .. 255 ] items

Items Enum: "BLOCK" "UNBLOCK"

List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the availability table. In case you are configuring inbound Subscription please check all the details available here.

criteria

Array of objects [ 0 .. 255 ] items

Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.

Array

applicationId	string [ 0 .. 255 ] characters CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic.
entityId	string [ 0 .. 255 ] characters CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.
callsConfigurationId	string [ 0 .. 255 ] characters CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic.

resources

Array of strings [ 0 .. 255 ] items

List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.

users

Array of strings [ 0 .. 255 ] items

List of users to match. You can provide usernames from your account.

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


{"name": "Updated group",
"profile": 
{"profileId": "NOTIF-98765"
},
"events": 
["DELIVERY"
],
"criteria": 
[
{"applicationId": "production",
"entityId": "entity1"
},
{"applicationId": "production",
"entityId": "entity2"
},
{"applicationId": "test",
"entityId": "entity1"
}
],
"resources": 
["1234"
],
"users": 
["user1",
"user2"
]
}

Response samples

Content type

application/json

Copy

Collapse all


{"subscriptionId": "ABC-123-DEF",
"profile": 
{"profileId": "NOTIF-32395",
"security": 
{"authId": "NEWAUTH-9291"
}
}
}

Need assistance

Explore Infobip Tutorials

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

Privacy documents Terms of use