Update a customer portal
curl --request PUT \
--url https://app.hookie.ai/admin/api/projects/{project_id}/portals/{portal_id} \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"event_types": [
"<string>"
],
"branding": {},
"enabled": true
}
'const options = {
method: 'PUT',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', event_types: ['<string>'], branding: {}, enabled: true})
};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/portals/{portal_id}', 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}/portals/{portal_id}"
payload = {
"name": "<string>",
"event_types": ["<string>"],
"branding": {},
"enabled": True
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"ok": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Portals
Update a customer portal
PUT
/
admin
/
api
/
projects
/
{project_id}
/
portals
/
{portal_id}
Update a customer portal
curl --request PUT \
--url https://app.hookie.ai/admin/api/projects/{project_id}/portals/{portal_id} \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"event_types": [
"<string>"
],
"branding": {},
"enabled": true
}
'const options = {
method: 'PUT',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', event_types: ['<string>'], branding: {}, enabled: true})
};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/portals/{portal_id}', 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}/portals/{portal_id}"
payload = {
"name": "<string>",
"event_types": ["<string>"],
"branding": {},
"enabled": True
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"ok": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Body
application/json
PATCH is accepted on this path and behaves identically. slug cannot be changed. Note the mixed semantics: name is COALESCE'd (omitted or blank keeps the current name) while event_types and branding are REPLACED — omitting them clears them to [] and {}.
Trimmed. Omitted or blank leaves the existing name unchanged.
Full replacement. Omitted clears it to [].
Full replacement. Omitted clears it to {}.
Only the literal false disables; every other value (including omission) re-enables.
Response
Updated.
Available options:
true