MEP APIs

Disable a Subscription

This operation allows you to disable a subscription.

Once disabled, MEP ignores the subscription when processing SMS or MMS messages. For example, a broadcasts to the subscription will not send messages.
You will not be able to add or remove end users via the Add End User to a Subscription or Remove an End User from a Subscription operations.
You will not be able to add or remove end users manually in the MEP UI.
However, MEP will continue to add or remove users if the subscription is part of a service.

If required, you can re-enable a subscription; however you must do this from the MEP UI.

Note: You cannot disable a protected subscription with this operation. For information about these, see Protected subscriptions.

Quick facts

Method	GET
Returns	Plain text
Available	All regions
Prerequisites	You must have MEP provisioned with OpenMarket, and the following roles set in the user account: Main Roles: Subscription Manager/User Other Roles: View and download user details, HTTP Subscription API user
More information	See MEP Operations and Making Subscription Requests.

Try It Out

If you'd like to try out this call using cURL, see Making Subscription Requests, which will take you through tasks such as creating and disabling subscriptions, and adding or removing end users.

Making a Request

Definition

GET https://cmx2api.openmarket.com/subscriptionapi/disablesubscription

URL example

https://cmx2api.openmarket.com/subscriptionapi/disablesubscription?username=MyUsername&password=P4S5W0Rd&subscription=A1B2C3D4E5F6

Query parameters

Parameters must be URL encoded.

Parameter	Description
username	The username used to access MEP. Required: yes Type: string
password	The password associated with the MEP username. Required: yes Type: string
subscription	The ID of the subscription you are disabling. Required: yes Type: string

Parameter

Description

username

The username used to access MEP.

Required: yes

Type: string

password

The password associated with the MEP username.

Required: yes

Type: string

subscription

The ID of the subscription you are disabling.

Required: yes

Type: string

Header fields

There is no data required in the header.

Response from OpenMarket

Accepted requests

OpenMarket responds to a successful request with a status code of 200 and "OK" in the body.

HTTP/1.1 200 OK
Date: Tue, 15 Mar 2016 18:02:57 GMT
Server: Apache-Coyote/1.1
Content-Length: 2
Content-Type: text/plain

OK

Rejected requests

If your request is rejected then the body of the response will contain a plain text description of the error. For example:

HTTP/1.1 403 Forbidden
Date: Tue, 15 Mar 2016 11:48:56 GMT
Server: Apache-Coyote/1.1
Connection: close
Transfer-Encoding: chunked
Content-Type: text/plain
			
Cannot disable protected subscription

See Response error messages below for a list of the possible error messages.

Testing your integration

As subscription operations do not send messages, the best way to test your integration is directly with MEP. We recommend that you test regularly as you build your campaigns and services in MEP, so that you can troubleshoot any issues faster.

For more information on using each operation, see Making Subscription Requests.

Troubleshooting

Response error messages

These error messages are returned in the response body when there was a problem with receiving the request.

Message	Description
Your request is invalid, specifically the following parameter is incorrect: <parameter>=<value>	You request contains a problem with the specified mandatory parameter that has stopped MEP from being able to process the request. If the <value> is “null”, then the parameter name is misspelled or the parameter is missing. Otherwise, the value you specified is invalid or does not match the available options. Correct the error and resend the message.
Your username and/or password is incorrect. Check and try again.	Either the username or the password parameter has not been correctly specified. Both parameters are mandatory. Check that both parameters are specified, and that you have entered the correct values for each parameter.
Cannot disable protected subscription	The subscription is protected and cannot be disabled using this operation. For information about these, see Protected subscriptions.
You do not have the necessary roles or permissions to perform the action: <description>	Your access rights in MEP do not allow you use the operation. The information in the <description> part of the response will tell you the role or permission that you are missing.