Delete a loyalty currency

curl --request DELETE \
  --url https://admin.snagsolutions.io/api/loyalty/currencies/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'DELETE', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://admin.snagsolutions.io/api/loyalty/currencies/{id}', 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://admin.snagsolutions.io/api/loyalty/currencies/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-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"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.snagsolutions.io/api/loyalty/currencies/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.snagsolutions.io/api/loyalty/currencies/{id}")

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

request = Net::HTTP::Delete.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "id": "123e4567-e89b-12d3-a456-426614174005",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "imageUrl": "https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png",
  "name": "Loyalty Points",
  "symbol": "LP",
  "decimals": 2,
  "createdById": "123e4567-e89b-12d3-a456-426614174010",
  "createdAt": "2023-10-01T12:34:56.000Z",
  "updatedAt": "2023-10-05T15:30:00.000Z",
  "apiGetUrl": "https://api.example.com/get-loyalty",
  "apiGetTransactionEntryUrl": "https://api.example.com/get-loyalty",
  "apiPostUrl": "https://api.example.com/post-loyalty",
  "apiAuthType": "basic",
  "apiAuthKey": "apiKey123",
  "apiAuthValue": "apiValue456",
  "sortId": 1,
  "deletedAt": null,
  "isTokenRewardCurrency": false
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "success": false,
  "message": "Internal server error",
  "debugInfo": "Stack trace or additional error details"
}

DELETE

api

loyalty

currencies

{id}

Delete a loyalty currency

curl --request DELETE \
  --url https://admin.snagsolutions.io/api/loyalty/currencies/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'DELETE', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://admin.snagsolutions.io/api/loyalty/currencies/{id}', 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://admin.snagsolutions.io/api/loyalty/currencies/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-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"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.snagsolutions.io/api/loyalty/currencies/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.snagsolutions.io/api/loyalty/currencies/{id}")

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

request = Net::HTTP::Delete.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "id": "123e4567-e89b-12d3-a456-426614174005",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "imageUrl": "https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png",
  "name": "Loyalty Points",
  "symbol": "LP",
  "decimals": 2,
  "createdById": "123e4567-e89b-12d3-a456-426614174010",
  "createdAt": "2023-10-01T12:34:56.000Z",
  "updatedAt": "2023-10-05T15:30:00.000Z",
  "apiGetUrl": "https://api.example.com/get-loyalty",
  "apiGetTransactionEntryUrl": "https://api.example.com/get-loyalty",
  "apiPostUrl": "https://api.example.com/post-loyalty",
  "apiAuthType": "basic",
  "apiAuthKey": "apiKey123",
  "apiAuthValue": "apiValue456",
  "sortId": 1,
  "deletedAt": null,
  "isTokenRewardCurrency": false
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "success": false,
  "message": "Internal server error",
  "debugInfo": "Stack trace or additional error details"
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Response

200

Schema for a loyalty currency

string<uuid>

required

Unique identifier for the loyalty currency

Example:

"123e4567-e89b-12d3-a456-426614174005"

organizationId

string<uuid>

required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId

string<uuid>

required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174002"

imageUrl

string | null

required

URL of the image

Example:

"https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png"

name

string

required

Name of the loyalty currency

Example:

"Loyalty Points"

symbol

string

required

Symbol representing the loyalty currency

Example:

"LP"

decimals

number

required

Number of decimal places for the currency

Required range: x >= 0

Example:

2

createdById

string<uuid> | null

required

ID of the user who created the currency

Example:

"123e4567-e89b-12d3-a456-426614174010"

createdAt

string<date-time>

required

Timestamp when the currency was created

Example:

"2023-10-01T12:34:56.000Z"

updatedAt

string<date-time>

required

Timestamp when the currency was last updated

Example:

"2023-10-05T15:30:00.000Z"

apiGetUrl

string | null

required

API GET URL for fetching data

Example:

"https://api.example.com/get-loyalty"

apiGetTransactionEntryUrl

string | null

required

API GET URL for fetching transaction entry data

Example:

"https://api.example.com/get-loyalty"

apiPostUrl

string | null

required

API POST URL for sending data

Example:

"https://api.example.com/post-loyalty"

apiAuthType

enum<string> | null

required

Type of authentication used for API

Available options:

none,

basic,

bearer,

apiKey

Example:

"basic"

apiAuthKey

string | null

required

Authentication key for API

Example:

"apiKey123"

apiAuthValue

string | null

required

Authentication value for API

Example:

"apiValue456"

sortId

number | null

required

Sorting identifier

Example:

1

deletedAt

string<date-time> | null

required

Timestamp when the currency was deleted, if applicable

Example:

null

isTokenRewardCurrency

boolean

True for LoyaltyCurrency rows auto-created by resolveTokenReward (Option 1 hidden currency backing a token-reward rule). Excluded from list responses by default; opt in via excludeTokenRewardCurrencies=false on the list endpoint.

Example:

false

API Documentation

Asset

Auction

Contract

Identity

Loyalty

Badge

Social Posts

Minting

Question

Stratus

Referrals

Website

Landing Page

Token Claims

Delete a loyalty currency

Authorizations

Path Parameters

Response