Unarchive Custom Segment

curl --request PATCH \
  --url https://api-{dc}.moengage.com/v2/custom-segments/unarchive \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "custom_segment_unique_name"
}
'

import requests

url = "https://api-{dc}.moengage.com/v2/custom-segments/unarchive"

payload = { "name": "custom_segment_unique_name" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'custom_segment_unique_name'})
};

fetch('https://api-{dc}.moengage.com/v2/custom-segments/unarchive', 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-{dc}.moengage.com/v2/custom-segments/unarchive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'custom_segment_unique_name'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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-{dc}.moengage.com/v2/custom-segments/unarchive"

	payload := strings.NewReader("{\n  \"name\": \"custom_segment_unique_name\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.patch("https://api-{dc}.moengage.com/v2/custom-segments/unarchive")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"custom_segment_unique_name\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-{dc}.moengage.com/v2/custom-segments/unarchive")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"custom_segment_unique_name\"\n}"

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

{
  "message": "Successfully unarchived the custom segment",
  "success": true,
  "cs_name": "custom_segment_unique_name"
}

{
  "title": "Invalid Request",
  "description": "<message>"
}

{
  "title": "Authentication required",
  "description": "<message>"
}

{
  "title": "Entity Not Found",
  "description": "Custom segment not found with the given name: <custom_segment_unique_name>"
}

{
  "title": "Internal Server Error"
}

PATCH

custom-segments

unarchive

Unarchive Custom Segment

curl --request PATCH \
  --url https://api-{dc}.moengage.com/v2/custom-segments/unarchive \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "custom_segment_unique_name"
}
'

import requests

url = "https://api-{dc}.moengage.com/v2/custom-segments/unarchive"

payload = { "name": "custom_segment_unique_name" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'custom_segment_unique_name'})
};

fetch('https://api-{dc}.moengage.com/v2/custom-segments/unarchive', 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-{dc}.moengage.com/v2/custom-segments/unarchive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'custom_segment_unique_name'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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-{dc}.moengage.com/v2/custom-segments/unarchive"

	payload := strings.NewReader("{\n  \"name\": \"custom_segment_unique_name\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.patch("https://api-{dc}.moengage.com/v2/custom-segments/unarchive")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"custom_segment_unique_name\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-{dc}.moengage.com/v2/custom-segments/unarchive")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"custom_segment_unique_name\"\n}"

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

{
  "message": "Successfully unarchived the custom segment",
  "success": true,
  "cs_name": "custom_segment_unique_name"
}

{
  "title": "Invalid Request",
  "description": "<message>"
}

{
  "title": "Authentication required",
  "description": "<message>"
}

{
  "title": "Entity Not Found",
  "description": "Custom segment not found with the given name: <custom_segment_unique_name>"
}

{
  "title": "Internal Server Error"
}

Authorizations

Authorization

string

header

required

Basic Authentication using your Workspace ID (as username) and Data API Key (as password) from the MoEngage Dashboard.

Body

application/json

The name of the custom segment to be unarchived.

Schema for requests that only require the segment name.

name

string

required

The name of the custom segment.

Response

Custom-segment unarchive request accepted.

message

string

The status message of the request.

success

boolean

Indicates if the request was accepted.

Example:

true

cs_name

string

The unique name of the custom segment being processed.

Getting Started

Endpoints

Unarchive Custom Segment

Authorizations

Body

Response