Send subscription share invitation

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

This API initiates the sharing of a subscription by sending a share request to the share recipient.

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/subscription/share/invitation' \ --header 'Content-Type: application/json' \ --data-raw '{ "contact": "kari.nordmann@gmail.com", "contactType": "A", "productCode": "CO27409" }'

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

contact

string

required

Email address or telephone number.
A phone number has to follow the telephone number standard E.164.

contactType

string

required

A_EMAIL: Email address

B_PHONENUMBER: Telephone number

productCode

string

required

Product the subscriber wishes to share

<= 12 characters

firstName

string

optional

First (given) name.

<= 30 characters

lastName

string

optional

Last (family) name.

<= 30 characters

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

🟠429Too Many Requests

🔴500Server Error