Cancel sharing - Connect

The user needs to be logged in to use this endpoint, click here to read more.

This API cancels sharing of a subscription.

curl --location --request PATCH 'https://api.mediaconnect.no/capi/v1/subscription/share' \ --header 'Content-Type: application/json' \ --data-raw '{ "shareCode": "123AFDG", "changeType": "CANCEL" }'

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Body Params application/json

shareCode

string

required

Share code, the unique key to find given share

<= 255 characters

changeType

enum<string>

required

What type of change it is:

CANCEL: Cancel the share

Allowed value:

CANCEL

Examples

Responses

🟢200OK

application/json

Body

status

enum<string>

required

SHARE_OK: A share request has been sent to the recipient.

NO_SUBSCRIPTION: No subscription to share.

SUBSCRIPTION_STOPPED: Subscription is stopped and cannot be shared.

REQUEST_ACCEPTED: Share request has been accepted.

REQUEST_DECLINED: Share request has been declined.

SHARING_ENDED: Share has ended.

SHARE_CODE_NOT_FOUND: Share code was not found.

SHARE_CHANGE_TYPE_NOT_SUPPORTED: Share change type is not supported.

ALREADY_IN_USE: Share for the specified contact is already in use.

SHARE_LIMIT: When another sharing was accepted and user can't accept this sharing until the other sharing is ended.

INVITATIONS_POOL_EXHAUSTED: When all available invitations have been used and the user cannot send new ones until other sharing is ended.

Allowed values:

SHARE_OKNO_SUBSCRIPTIONSUBSCRIPTION_STOPPEDREQUEST_ACCEPTEDREQUEST_DECLINEDSHARING_ENDEDSHARE_CODE_NOT_FOUNDSHARE_CHANGE_TYPE_NOT_SUPPORTEDALREADY_IN_USESHARE_LIMITINVITATIONS_POOL_EXHAUSTED

🟠400Bad Request

🟠429429

🔴500Server Error