Create Campaign Rule

POST

campaign-rules

Create campaign rule

curl --request POST \
  --url https://api-sandbox.y.uno/v1/campaign-rules \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "campaign_id": "c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f",
  "name": "10% off cards",
  "conditions": {
    "payment_method": "CARD",
    "min_amount": 100
  },
  "benefit": {
    "type": "DISCOUNT",
    "value": 10,
    "unit": "PERCENTAGE"
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/campaign-rules"

payload = {
    "campaign_id": "c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f",
    "name": "10% off cards",
    "conditions": {
        "payment_method": "CARD",
        "min_amount": 100
    },
    "benefit": {
        "type": "DISCOUNT",
        "value": 10,
        "unit": "PERCENTAGE"
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaign_id: 'c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f',
    name: '10% off cards',
    conditions: {payment_method: 'CARD', min_amount: 100},
    benefit: {type: 'DISCOUNT', value: 10, unit: 'PERCENTAGE'}
  })
};

fetch('https://api-sandbox.y.uno/v1/campaign-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/campaign-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => 'c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f',
    'name' => '10% off cards',
    'conditions' => [
        'payment_method' => 'CARD',
        'min_amount' => 100
    ],
    'benefit' => [
        'type' => 'DISCOUNT',
        'value' => 10,
        'unit' => 'PERCENTAGE'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/campaign-rules"

	payload := strings.NewReader("{\n  \"campaign_id\": \"c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"name\": \"10% off cards\",\n  \"conditions\": {\n    \"payment_method\": \"CARD\",\n    \"min_amount\": 100\n  },\n  \"benefit\": {\n    \"type\": \"DISCOUNT\",\n    \"value\": 10,\n    \"unit\": \"PERCENTAGE\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/campaign-rules")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": \"c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"name\": \"10% off cards\",\n  \"conditions\": {\n    \"payment_method\": \"CARD\",\n    \"min_amount\": 100\n  },\n  \"benefit\": {\n    \"type\": \"DISCOUNT\",\n    \"value\": 10,\n    \"unit\": \"PERCENTAGE\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/campaign-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": \"c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"name\": \"10% off cards\",\n  \"conditions\": {\n    \"payment_method\": \"CARD\",\n    \"min_amount\": 100\n  },\n  \"benefit\": {\n    \"type\": \"DISCOUNT\",\n    \"value\": 10,\n    \"unit\": \"PERCENTAGE\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "conditions": {},
  "benefit": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Authorizations

public-api-key

string

header

required

Your public API key from the Yuno Dashboard

private-secret-key

string

header

required

Your private secret key (server-side only)

Body

application/json

campaign_id

string<uuid>

required

Associated campaign ID

name

string

required

Rule name

conditions

object

required

Show child attributes

benefit

object

required

Show child attributes

Response

Campaign rule created

string<uuid>

campaign_id

string<uuid>

name

string

status

enum<string>

Available options:

ACTIVE,

INACTIVE

conditions

object

benefit

object

created_at

string<date-time>

updated_at

string<date-time>

Create campaign rule

curl --request POST \
  --url https://api-sandbox.y.uno/v1/campaign-rules \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "campaign_id": "c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f",
  "name": "10% off cards",
  "conditions": {
    "payment_method": "CARD",
    "min_amount": 100
  },
  "benefit": {
    "type": "DISCOUNT",
    "value": 10,
    "unit": "PERCENTAGE"
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/campaign-rules"

payload = {
    "campaign_id": "c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f",
    "name": "10% off cards",
    "conditions": {
        "payment_method": "CARD",
        "min_amount": 100
    },
    "benefit": {
        "type": "DISCOUNT",
        "value": 10,
        "unit": "PERCENTAGE"
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaign_id: 'c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f',
    name: '10% off cards',
    conditions: {payment_method: 'CARD', min_amount: 100},
    benefit: {type: 'DISCOUNT', value: 10, unit: 'PERCENTAGE'}
  })
};

fetch('https://api-sandbox.y.uno/v1/campaign-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/campaign-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => 'c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f',
    'name' => '10% off cards',
    'conditions' => [
        'payment_method' => 'CARD',
        'min_amount' => 100
    ],
    'benefit' => [
        'type' => 'DISCOUNT',
        'value' => 10,
        'unit' => 'PERCENTAGE'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/campaign-rules"

	payload := strings.NewReader("{\n  \"campaign_id\": \"c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"name\": \"10% off cards\",\n  \"conditions\": {\n    \"payment_method\": \"CARD\",\n    \"min_amount\": 100\n  },\n  \"benefit\": {\n    \"type\": \"DISCOUNT\",\n    \"value\": 10,\n    \"unit\": \"PERCENTAGE\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/campaign-rules")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": \"c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"name\": \"10% off cards\",\n  \"conditions\": {\n    \"payment_method\": \"CARD\",\n    \"min_amount\": 100\n  },\n  \"benefit\": {\n    \"type\": \"DISCOUNT\",\n    \"value\": 10,\n    \"unit\": \"PERCENTAGE\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/campaign-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": \"c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f\",\n  \"name\": \"10% off cards\",\n  \"conditions\": {\n    \"payment_method\": \"CARD\",\n    \"min_amount\": 100\n  },\n  \"benefit\": {\n    \"type\": \"DISCOUNT\",\n    \"value\": 10,\n    \"unit\": \"PERCENTAGE\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "conditions": {},
  "benefit": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Getting started

Conventions

Core

Recurring

Hosted

Marketplace

Embedded finance

Operations

Recovery

Reference data

Authorizations

Body

Response