Updates the title and/ or description of the campaign. Updating a

Updates the title and/ or description of the campaign. Updating a record moved to the archive is forbidden.

Errors

• code: 400 message: ValidationError
• code: 400 message: NotUnique
• code: 404 message: NotFound

PATCH /api/campaigns/{campaign_code}

Updates the title and/ or description of the campaign. Updating a

cURL

curl --request PATCH \
  --url https://my.exnessaffiliates.com/api/campaigns/{campaign_code}/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "archived": true
}
'

200

{
  "campaign_code": "string",
  "title": "string",
  "link_count": "int",
  "archived": "bool",
  "is_blocked": "bool",
  "base_link": "string",
  "created": "datetime",
  "links": [
    {
      "link": "string",
      "platform": "string",
      "os": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "reward_schema": "string"
}

Path Parameters

campaign_code · string · required

Body

application/json

title · string

campaign title

description · string

campaign description

archived · boolean

archives the campaign

Response

200

*/*

OK

campaign_code · string · required

campaign code

Example:

"string"

title · string · required

campaign title

Example:

"string"

link_count · integer · required

number of agent links in campaign

Example:

"int"

archived · boolean · required

whether campaign archived or not

Example:

"bool"

is_blocked · boolean · required

is campaign blocked

Example:

"bool"

base_link · string · required

campaign base agent link

Example:

"string"

created · string · required

campaign creation date

Example:

"datetime"

links · object[] · required

campaign links

Show child attributes

Example:

[
  {
    "link": "string",
    "platform": "string",
    "os": "string",
    "tags": ["string"]
  }
]

reward_schema · string · required

campaign reward schema

Example:

"string"