Scope: contacts:contacts.read https://api.alladdin.com/api/v2/contacts/{contactId}/portal-link

Generates a portal access link for a specific contact. The link allows the contact to access their client portal where they can view documents. The link expires after 2 days.

Parameters

Path parameters

contactId string required

Contact ID (24-char hex ObjectId)

Request

import requests

url = "https://api.alladdin.com/api/v2/contacts/{contactId}/portal-link"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "url": "string",
  "expires_at": "2024-01-15T10:30:00Z"
}

Success responses

200 Portal link generated application/json object url string

Portal access URL for the contact

expires_at string<date-time>

Expiration date of the portal link in ISO 8601 format

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Contact not found application/json 422 Unable to generate portal link application/json 429 Rate limit exceeded application/json

← PreviousGet a contact attachment →

Next →Delete a contact →