Contact Endpoints
Operations
| Method | Route | Docs | Auth |
|---|---|---|---|
GET |
Contact/GetAll |
GetAll | Authorize |
GET |
Contact/GetById/{code} |
GetById | Authorize |
POST |
Contact/Create |
Create | Authorize |
PUT |
Contact/Update/{code} |
Update | Authorize |
DELETE |
Contact/Delete/{code} |
Delete | Authorize |
Scoping And Permissions
Reads default to the authenticated user's account (CustomerCode claim). Create, update, and
read accept optional customerCode so master contacts and account administrators can target
another allowed account.
- Read (
GetAll,GetById): defaults to the caller's account. SupplycustomerCodeto read another account (master contact, or an accountAdministratorwhose allowed set includes that code). A contact flagged to limit search to their own orders only sees their own record on their own account, unless they are an accountAdministrator. - Create: account
Administratoron their own account, or on bill-to accounts inAdditionalWebAccesswhen optional requestcustomerCodeis supplied. Master contacts may create under any account viacustomerCode. New contacts default towebAccess = Administratorand receive Payments API permission for their account. - Delete: account
Administratoronly (caller's account). - Update: an
Administratorcan update any contact on the account; other users can update only their own record. Master contacts can update under any account by supplyingcustomerCode. Web access level and the search-limit flag are administrator-only. - Delete is a soft delete: the contact is marked retired rather than removed.