Create codebreaker campaign

POST

https://api.mpc.dev.placewise.com/v1/management/games/codebreaker/campaigns

API Permit:name: Games:Api:Management:Codebreaker:Campaigns:Create

API Context:Loyalty Club

Authorizations:UserToken

Create codebreaker campaign

Request

Query Params

Header Params

Body Params application/json

Example

{
    "campaign": {
        "name": "Gordon O'Kon",
        "starts_at": "2025-11-06T10:23:28.311Z",
        "ends_at": "2025-11-06T10:23:28.312Z",
        "status": "draft",
        "code_length": 4,
        "member_frequency": 120,
        "bee_json": {},
        "codes": [
            "3962",
            "1712"
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/management/games/codebreaker/campaigns?dry_run=' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaign": {
        "name": "Gordon O'\''Kon",
        "starts_at": "2025-11-06T10:23:28.311Z",
        "ends_at": "2025-11-06T10:23:28.312Z",
        "status": "draft",
        "code_length": 4,
        "member_frequency": 120,
        "bee_json": {},
        "codes": [
            "3962",
            "1712"
        ]
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "campaign": {
        "id": 80,
        "name": "Cathy Jerde",
        "starts_at": "2025-10-03T13:00:00.721Z",
        "ends_at": "2025-10-03T16:00:00.721Z",
        "status": "draft",
        "code_length": 6,
        "member_frequency": 1809200,
        "webpage_url": "https://tiny-diversity.org",
        "bee_json": {},
        "html": "consectetur",
        "codes": [
            "834955",
            "564536"
        ],
        "thumbnail": {
            "identifier": "1",
            "created_at": "2022-11-09T15:46:00.252860Z",
            "image_details": null
        }
    }
}

🟠404Record Not Found

🟠422Invalid Parameters

Show codebreaker campaign

Update codebreaker campaign