Register recruitment - client mode

Production

https://api.mediaconnect.no/capi

POST

/v1/client/recruitment

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 register recruitments. The recruiter and the persons recruited are created in Connect. A recruitment is processed as an order in Connect.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/recruitment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product": "CO27409",
    "campaign": "Spring2019",
    "recruiter": {
        "name": {
            "firstName": "Kari",
            "middleName": "Snøhaug",
            "lastName": "Nordmann"
        },
        "address": {
            "streetAddress": "Osloveien",
            "streetNumber": 12,
            "entrance": "B",
            "floor": 3,
            "postalCode": "0101",
            "postalPlace": "Oslo",
            "postalAddress": "Postboks 6",
            "postalAddressPostalCode": "0216",
            "postalAddressPostalPlace": "Oslo",
            "countryCode": "NO"
        },
        "phoneNumber": "+4787654321",
        "email": "kari.nordmann@gmail.com"
    },
    "recruitmentPremiumPreferences": [
        {
            "companyCode": "468979834",
            "product": "HS3829",
            "preferenceNumber": 1
        }
    ],
    "recruitments": [
        {
            "name": {
                "firstName": "Ola",
                "middleName": "Fjordstrand",
                "lastName": "Nordmann",
                "companyName": "Company International Ltd",
                "departmentName": "Support"
            },
            "address": {
                "streetAddress": "Grubbegata",
                "streetNumber": 6,
                "entrance": "A",
                "floor": 6,
                "postalCode": 179,
                "postalPlace": "Oslo",
                "postalAddress": "Postboks 265 Økern",
                "postalAddressPostalCode": "0510",
                "postalAddressPostalPlace": "Oslo",
                "countryCode": "NO"
            },
            "couponCode": "WMDigi",
            "couponNumber": 5223,
            "amount": 1,
            "quantity": 1,
            "phoneNumber": "+4712345678",
            "email": "ola.nordmann@company.com"
        }
    ]
}'

Response Example

200 - Success

{
    "status": "ok"
}

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

product

string

required

Product code. The product must be a subcription product.

<= 12 characters

campaign

string

required

Campaign code

<= 12 characters

recruiter

object

required

The recruiter

name

object

required

address

object (Address)

required

phoneNumber

string

optional

The recruiters phonenumber.

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

<= 20 characters

string <email>

optional

The recruiters email

<= 255 characters

recruitmentPremiumPreferences

array [object {3}]

optional

Missing list, i.e element missing, cause no changes in existing premium preferences.

List (empty or not) result in replacing existing premium preferences, i.e empty list will remove all premium preferences.

companyCode

string

required

The company that owns the product

<= 12 characters

product

string

required

The premium product

<= 12 characters

preferenceNumber

integer

required

The preference number for this premium, representing the sorting order of wanted premiums, with 1 representing the preferred premium product.

recruitments

array [object {8}]

required

name

object

required

address

object (Address)

required

couponCode

string

required

Coupon code used when starting the recuited persons subscription

<= 12 characters

couponNumber

integer

required

Coupon number used when starting the recuited persons subscription

amount

number

required

Amount to use on the recuited one. This is usually zero, but may have another value. Must be greater or equals to zero

>= 0

Multiple of:

0.01

quantity

integer

required

Number of copies used when starting. This is usually 1, but may have another value. Must be greater or equals to 1

>= 1

phoneNumber

string

optional

Recruits phone number.

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

<= 20 characters

string <email>

optional

Recruits e-mail addresse

<= 255 characters

Examples

Responses

🟢200OK

application/json

Body

status

string

optional

The value "ok" if the request was received and processed successfully.

🟠400Bad Request

🟠429Too Many Requests

🔴500Server Error

Modified at 2025-05-08 08:07:34

List subscriptions - client mode

List recruitments