Remove the project's customer portal for good
curl --request DELETE \
--url https://app.hookie.ai/admin/api/projects/{project_id}/portal \
--header 'Content-Type: application/json' \
--data '
{
"confirm": "<string>"
}
'const options = {
method: 'DELETE',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({confirm: '<string>'})
};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/portal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{project_id}/portal"
payload = { "confirm": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"portal": null
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}Portals
Remove the project's customer portal for good
Retires the portal: retired_at is set and it is switched off, every live access token is revoked, the pending deliveries (queued, retrying or paused) of its customers’ destinations are cancelled, and one remove_portal audit row records it with counts. Nothing is deleted: the portal row, its customers’ destinations and their delivery history stay. The project can then have a new portal. Unlike switching the portal off (enabled: false), this cannot be undone. The body must repeat the portal’s name as confirm.
DELETE
/
admin
/
api
/
projects
/
{project_id}
/
portal
Remove the project's customer portal for good
curl --request DELETE \
--url https://app.hookie.ai/admin/api/projects/{project_id}/portal \
--header 'Content-Type: application/json' \
--data '
{
"confirm": "<string>"
}
'const options = {
method: 'DELETE',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({confirm: '<string>'})
};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/portal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{project_id}/portal"
payload = { "confirm": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"portal": null
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}