Allowlist an inbox sender - Slash

POST

/

v2

/

bills

/

inbox

/

senders

Allowlist an inbox sender

curl --request POST \
  --url https://api.slash.com/v2/bills/inbox/senders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "value": "billing@vendor.com"
}
'

const options = {
  method: 'POST',
  headers: {
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({value: 'billing@vendor.com'})
};

fetch('https://api.slash.com/v2/bills/inbox/senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/bills/inbox/senders"

payload = { "value": "billing@vendor.com" }
headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/bills/inbox/senders"

	payload := strings.NewReader("{\n  \"value\": \"billing@vendor.com\"\n}")

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

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-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))

}

{
  "id": "ais_2rj4l7hmrrrcv",
  "type": "email",
  "value": "billing@vendor.com",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Body

application/json

Allowlist an email address or a whole domain for the accounts-payable inbox.

type

enum<string>

required

email to allowlist one address, domain to allowlist every address at a domain.

Available options:

email,

domain

value

string

required

The address (billing@vendor.com) or bare domain (vendor.com), matched case-insensitively. Public mail providers such as gmail.com cannot be allowlisted as a domain; add the individual address instead.

Required string length: 1 - 254

Example:

"billing@vendor.com"

Response

The allowlisted sender.

An email address or domain the legal entity has allowlisted for its accounts-payable inbox. Invoices from an allowlisted sender become draft bills even when the sender is not a user, on the company's domain, or a known vendor.

id

string

required

Sender id with the ais_ prefix. Remove the sender with DELETE /v2/bills/inbox/senders/{senderId}.

Example:

"ais_2rj4l7hmrrrcv"

type

enum<string>

required

email matches one address exactly; domain matches every address at that domain.

Available options:

email,

domain

value

string

required

The lowercased address or bare domain.

Example:

"billing@vendor.com"

createdAt

string<date-time>

required

When the sender was allowlisted.

⌘I

Allowlist an inbox sender

curl --request POST \
  --url https://api.slash.com/v2/bills/inbox/senders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "value": "billing@vendor.com"
}
'

const options = {
  method: 'POST',
  headers: {
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({value: 'billing@vendor.com'})
};

fetch('https://api.slash.com/v2/bills/inbox/senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/bills/inbox/senders"

payload = { "value": "billing@vendor.com" }
headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/bills/inbox/senders"

	payload := strings.NewReader("{\n  \"value\": \"billing@vendor.com\"\n}")

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

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-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))

}

{
  "id": "ais_2rj4l7hmrrrcv",
  "type": "email",
  "value": "billing@vendor.com",
  "createdAt": "2023-11-07T05:31:56Z"
}