POST
/
api
/
loyalty
/
rule_edits
/
{id}
/
restore
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const response = await client.loyalty.ruleEdits.restore('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

  console.log(response.id);
}

main();
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "organizationId": "123e4567-e89b-12d3-a456-426614174003",
  "editedByUserId": "123e4567-e89b-12d3-a456-426614174004",
  "editedAt": "2021-08-30T20:00:00Z",
  "action": "create",
  "data": {
    "name": "New Rule Name"
  },
  "previousData": {
    "name": "Old Rule Name"
  },
  "comment": "Updated rule name"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Body

application/json · object
Body

The body is of type object.

Response

200
application/json
200
​
id
string
required

Unique identifier for the rule edit

Example:

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

​
loyaltyRuleId
string
required

ID of the loyalty rule

Example:

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

​
websiteId
string
required

Unique identifier for the website

Example:

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

​
organizationId
string
required

Unique identifier for the organization

Example:

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

​
editedByUserId
string
required

User ID of the user who made the edit

Example:

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

​
editedAt
string
required

Timestamp of when the rule edit was made

Example:

"2021-08-30T20:00:00Z"

​
action
enum<string>
required

Type of action that was made on the rule

Available options:
create,
update,
delete,
restore
Example:

"create"

​
data
object
required

Data that was changed on the rule

Example:
{ "name": "New Rule Name" }
​
previousData
object

Previous data of the rule before the edit

Example:
{ "name": "Old Rule Name" }
​
comment
string

Comment that was made on the edit

Example:

"Updated rule name"

Was this page helpful?