Karia
Guides

Contact

Create and maintain contacts, addresses, and contact methods

Contact Guide

Use the contact endpoints to manage workspace-scoped contact records and their nested address and communication method data.

Primary Workflow

  1. List or create contacts with GET and POST /organisation/{orgId}/workspace/{workspaceId}/contact.
  2. Fetch or update a single contact via /contact/{contactId}.
  3. Attach address records with /contact/{contactId}/address.
  4. Attach communication methods with /contact/{contactId}/method.

Reference

Covered Operations

  • GET|POST /organisation/{orgId}/workspace/{workspaceId}/contact
  • GET|PATCH /organisation/{orgId}/workspace/{workspaceId}/contact/{contactId}
  • POST /organisation/{orgId}/workspace/{workspaceId}/contact/{contactId}/address
  • PATCH|DELETE /organisation/{orgId}/workspace/{workspaceId}/contact/{contactId}/address/{addressId}
  • POST /organisation/{orgId}/workspace/{workspaceId}/contact/{contactId}/method
  • PATCH|DELETE /organisation/{orgId}/workspace/{workspaceId}/contact/{contactId}/method/{methodId}

On this page