Skip to main content
POST
/
allowlists
Create Allowlist Item
curl --request POST \
  --url https://api.loopreturns.com/api/v1/allowlists \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "value": "<string>",
  "type": "order",
  "secondary_value": "<string>"
}
'
{
  "id": 123,
  "type": "order",
  "value": "<string>",
  "secondary_value": "<string>"
}

Authorizations

​
X-Authorization
string
header
required

Body

application/json
​
value
string
required

The allowed value. Returns made using this value will override any other return ineligibility.

Example:

"[email protected]"

​
type
enum<string>
required

The type of value allowed by this allowlist entry.

Available options:
order,
product,
email,
product_tag
Example:

"email"

​
secondary_value
string

This value is not used.

Example:

"[email protected]"

Response

Success

​
id
integer

The unique identifier associated with the allowlist entry.

Example:

1

​
type
enum<string>

The type of value allowed by this allowlist entry. order is the order number of the allowed order and email is the customer's email address.

Available options:
order,
email
​
value
string

The allowed value. Returns made using this value will override any other return ineligibility.

Example:

"[email protected]"

​
secondary_value
string

This value is not used.

Example:

"[email protected]"