Update a compliance portal

puthttps://api.expiryedge.com/v1/updatePortal
admin60/min
Request
curl -X PUT 'https://api.expiryedge.com/v1/updatePortal' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "portalId": "prt_5Vb1nK",
  "is_active": false
}'
Response
{
  "success": true
}

Partial update: only the fields you send change. password: "" removes the password. Returns 403 for another organization's portal.

Body parameters

application/json
  • portalIdstringrequired
  • is_activeboolean
  • namestring
    Required on create.
  • descriptionstring
  • client_namestring
  • client_emailstring
  • expiry_idsarray of string
    Expiry ids shown on the portal. Every id must belong to your organization (400 otherwise); duplicates are removed.
    max items: 1000
  • passwordstring
    Optional viewer password. On update, an empty string removes the password. Never returned.
  • link_expires_atstring | null
    After this time viewPortal returns 410.
    format: date-time

Returns

200
Updated.
  • successboolean
  • messagestring

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.