Email Address can be added to change the sender of outgoing emails.
Setting up an email address requires a verification process. The code will be sent to the email address and the user has to click on a link to verify it. Additionally, the domain of the email address has to be verified by adding DNS CNAME records which will be returned by the API after the email address is added.
NOTE: Email addresses can be added to an organization or an account. If added to an account, it will be used for all organizations that belong to that account, otherwise it will be used only for the specified organization.
Endpoints:
- POST /v1/email-address
- GET /v1/email-address
- DELETE /v1/email-address
- GET /v1/email-address/status
- POST /v1/email-address/resend-verification
- POST /v1/organizations/:id/email-address
- GET /v1/organizations/:id/email-address
- DELETE /v1/organizations/:id/email-address
- GET /v1/organizations/:id/email-address/status
- POST /v1/organizations/:id/email-address/resend-verification
The EmailAddress object
Parameters
-
id string readonly
-
email string
-
emailVerificationStatus string
-
domainVerificationStatus string
-
tokens array[string]
-
accountId string
-
organizationId string
-
createdAt date readonly
-
updatedAt date readonly
Additional propertiesExpand all
{
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"id": "string",
"email": "string",
"emailVerificationStatus": "string",
"domainVerificationStatus": "string",
"tokens": ["string"],
"accountId": "string",
"organizationId": "string"
}
const response = await fetch('https://api.spaceinvoices.com/v1/email-address', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
email: 'string'
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/email-address \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"email": "string"
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/email-address'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'email': 'string'
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
}
const response = await fetch('https://api.spaceinvoices.com/v1/email-address', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/email-address \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/email-address'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"id": "string",
"email": "string",
"emailVerificationStatus": "string",
"domainVerificationStatus": "string",
"tokens": ["string"],
"accountId": "string",
"organizationId": "string"
}
const response = await fetch('https://api.spaceinvoices.com/v1/email-address', {
method: 'DELETE',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X DELETE https://api.spaceinvoices.com/v1/email-address \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/email-address'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 1
}
const response = await fetch('https://api.spaceinvoices.com/v1/email-address/status', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/email-address/status \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/email-address/status'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"emailVerificationStatus": "string",
"domainVerificationStatus": "string"
}
const response = await fetch('https://api.spaceinvoices.com/v1/email-address/resend-verification', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/email-address/resend-verification \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/email-address/resend-verification'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"success": true
}
Create EmailAddress on Organization
POST /v1/organizations/:id/email-address
Parameters
Path
-
id string required
Properties
-
email string required
const response = await fetch('https://api.spaceinvoices.com/v1/organizations/{id}/email-address', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
email: 'string'
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/organizations/{id}/email-address \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"email": "string"
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/organizations/{id}/email-address'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'email': 'string'
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"id": "string",
"email": "string",
"emailVerificationStatus": "string",
"domainVerificationStatus": "string",
"tokens": ["string"],
"accountId": "string",
"organizationId": "string"
}
Get Organization EmailAddresses
GET /v1/organizations/:id/email-address
Parameters
Path
-
id string required
const response = await fetch('https://api.spaceinvoices.com/v1/organizations/{id}/email-address', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/organizations/{id}/email-address \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/organizations/{id}/email-address'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"id": "string",
"email": "string",
"emailVerificationStatus": "string",
"domainVerificationStatus": "string",
"tokens": ["string"],
"accountId": "string",
"organizationId": "string"
}
Delete Organization EmailAddresses
DELETE /v1/organizations/:id/email-address
Parameters
Path
-
id string required
const response = await fetch('https://api.spaceinvoices.com/v1/organizations/{id}/email-address', {
method: 'DELETE',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X DELETE https://api.spaceinvoices.com/v1/organizations/{id}/email-address \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/organizations/{id}/email-address'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 1
}
Get Organization EmailAddresses status
GET /v1/organizations/:id/email-address/status
Parameters
Path
-
id string required
const response = await fetch('https://api.spaceinvoices.com/v1/organizations/{id}/email-address/status', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/organizations/{id}/email-address/status \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/organizations/{id}/email-address/status'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"emailVerificationStatus": "string",
"domainVerificationStatus": "string"
}
Resend Organization EmailAddress verification
POST /v1/organizations/:id/email-address/resend-verification
Parameters
Path
-
id string required
Properties
const response = await fetch('https://api.spaceinvoices.com/v1/organizations/{id}/email-address/resend-verification', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/organizations/{id}/email-address/resend-verification \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/organizations/{id}/email-address/resend-verification'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"success": true
}