Set Offer Visibility - Everflow API

Set Offer Visibility

curl --request PUT \
  --url https://api.eflow.team/v1/networks/offers/{offerId}/visibility \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "network_affiliate_ids": [
    7,
    14
  ],
  "set_type": "visible"
}
'

import requests

url = "https://api.eflow.team/v1/networks/offers/{offerId}/visibility"

payload = {
    "network_affiliate_ids": [7, 14],
    "set_type": "visible"
}
headers = {
    "X-Eflow-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({network_affiliate_ids: [7, 14], set_type: 'visible'})
};

fetch('https://api.eflow.team/v1/networks/offers/{offerId}/visibility', 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.eflow.team/v1/networks/offers/{offerId}/visibility",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'network_affiliate_ids' => [
        7,
        14
    ],
    'set_type' => 'visible'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Eflow-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.eflow.team/v1/networks/offers/{offerId}/visibility"

	payload := strings.NewReader("{\n  \"network_affiliate_ids\": [\n    7,\n    14\n  ],\n  \"set_type\": \"visible\"\n}")

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

	req.Header.Add("X-Eflow-Api-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.put("https://api.eflow.team/v1/networks/offers/{offerId}/visibility")
  .header("X-Eflow-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"network_affiliate_ids\": [\n    7,\n    14\n  ],\n  \"set_type\": \"visible\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/offers/{offerId}/visibility")

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

request = Net::HTTP::Put.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"network_affiliate_ids\": [\n    7,\n    14\n  ],\n  \"set_type\": \"visible\"\n}"

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

{
  "network_id": 123,
  "network_offer_id": 123,
  "network_affiliate_visible_ids": [
    123
  ],
  "network_affiliate_rejected_ids": [
    123
  ],
  "network_affiliate_hidden_ids": [
    123
  ]
}

PUT

/

networks

/

offers

/

{offerId}

/

visibility

Set Offer Visibility

curl --request PUT \
  --url https://api.eflow.team/v1/networks/offers/{offerId}/visibility \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "network_affiliate_ids": [
    7,
    14
  ],
  "set_type": "visible"
}
'

import requests

url = "https://api.eflow.team/v1/networks/offers/{offerId}/visibility"

payload = {
    "network_affiliate_ids": [7, 14],
    "set_type": "visible"
}
headers = {
    "X-Eflow-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({network_affiliate_ids: [7, 14], set_type: 'visible'})
};

fetch('https://api.eflow.team/v1/networks/offers/{offerId}/visibility', 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.eflow.team/v1/networks/offers/{offerId}/visibility",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'network_affiliate_ids' => [
        7,
        14
    ],
    'set_type' => 'visible'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Eflow-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.eflow.team/v1/networks/offers/{offerId}/visibility"

	payload := strings.NewReader("{\n  \"network_affiliate_ids\": [\n    7,\n    14\n  ],\n  \"set_type\": \"visible\"\n}")

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

	req.Header.Add("X-Eflow-Api-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.put("https://api.eflow.team/v1/networks/offers/{offerId}/visibility")
  .header("X-Eflow-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"network_affiliate_ids\": [\n    7,\n    14\n  ],\n  \"set_type\": \"visible\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/offers/{offerId}/visibility")

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

request = Net::HTTP::Put.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"network_affiliate_ids\": [\n    7,\n    14\n  ],\n  \"set_type\": \"visible\"\n}"

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

{
  "network_id": 123,
  "network_offer_id": 123,
  "network_affiliate_visible_ids": [
    123
  ],
  "network_affiliate_rejected_ids": [
    123
  ],
  "network_affiliate_hidden_ids": [
    123
  ]
}

Update the visibility settings for a specific offer. This operation completely overwrites the existing visibility settings for the specified set type. Provide the list of affiliate IDs and the visibility type (visible or hidden).

Authorizations

X-Eflow-Api-Key

string

header

required

The Everflow API key generated from the Control Center > Security.

Path Parameters

offerId

integer

required

The offer ID.

Body

application/json

network_affiliate_ids

integer[]

required

List of affiliate IDs whose visibility will be set to the target set_type.

set_type

enum<string>

required

The type of visibility to apply to the specified affiliates. Values are visible, hidden, and rejected.

Available options:

visible,

hidden,

rejected

Response

200 - application/json

network_id

integer

Network ID.

network_offer_id

integer

Offer ID.

network_affiliate_visible_ids

integer[]

Updated list of affiliate IDs with visible access.

network_affiliate_rejected_ids

integer[]

Updated list of affiliate IDs with rejected access.

network_affiliate_hidden_ids

integer[]

Updated list of affiliate IDs with hidden access.