Check shield ordertype - client mode

Production

https://api.mediaconnect.no/capi

POST

/v1/client/shield/ordertype

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

Use this API to shield customer(s) on order type level by a given credential. The credential is used to find customers. All customers found will be shielded against activity on specified channel.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/shield/ordertype' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enterpriseCode": "468979834",
    "orderTypeCode": "56235",
    "channel": "DM",
    "credential": "+4712345678"
}'

Response Example

200 - Success

{
    "count": 0
}

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

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

Example:

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

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

enterpriseCode

string

required

Enterprise company code

<= 12 characters

orderTypeCode

string

required

Ordertype code

<= 12 characters

channel

string

required

Distribution channel code

<= 20 characters

credential

string

required

Credential - e.g mobile phonenumber or email address. I.e credential used in ConnectID

<= 60 characters

Examples

Responses

🟢200OK

application/json

Body

count

integer

optional

Number of customers found and shielded.

🟠400Bad Request

🟠429Too Many Requests

🔴500Server Error

Modified at 2025-05-08 08:01:06

Change ordertype permissions

Check shield enterprise - client mode