Contacts
Subcategories
API Endpoints
Create contact
Creates a new contact with a specific type
/{organizationId}/{mandateId}/crm/contactsGet contact
Returns a specific contact with all of its details
/{organizationId}/{mandateId}/crm/contacts/{contactId}Update contact
Updates basic contact information
/{organizationId}/{mandateId}/crm/contacts/{contactId}Delete contact
Deletes a given contact and all of its data
/{organizationId}/{mandateId}/crm/contacts/{contactId}Get readable contact custom fields
Returns custom field definitions, including inherited fields, for readable contact types
/{organizationId}/crm/contacts/custom-fieldsGets suggested subscription plans for a contact
GET/{organizationId}/{mandateId}/crm/contacts/{contactId}/suggested-plansGet data privacy information
Returns a PDF export with data privacy information for a contact
/{organizationId}/{mandateId}/crm/contacts/{contactId}/dataPrivacyInformationList contacts celebrations
Returns a list of contacts for the mandate that are celebrating events like birthdays, anniversaries, leaving or joining the membership
/{organizationId}/{mandateId}/crm/contacts/listContactsCelebrationsExport contacts celebrations
Exports a list of contacts for the mandate that are celebrating events like birthdays, anniversaries, leaving or joining the membership
/{organizationId}/{mandateId}/crm/contacts/exportContactsCelebrationsList contacts
Returns a list of contacts for the mandate
/{organizationId}/{mandateId}/crm/contacts/listUnclaim contact
Removes the connected user from a specific contact
/{organizationId}/{mandateId}/crm/contacts/{contactId}/unclaimAdd contact type
Adds an additional type to an existing contact
/{organizationId}/{mandateId}/crm/contacts/{contactId}/types/addPreview contact type removal
Checks removal permissions in every contact mandate and reports blockers and consequences without changing the contact.
/{organizationId}/{mandateId}/crm/contacts/{contactId}/types/{type}/removal-impactRemove a contact type
Removes one contact type after a fresh impact review. Refuses removal of the final type or unresolved dependencies. Preserves contact numbers and financial accounts.
/{organizationId}/{mandateId}/crm/contacts/{contactId}/types/removeChange contact debtor
Changes the debtor of a contact
/{organizationId}/{mandateId}/crm/contacts/{contactId}/debtorChange contact creditor
Changes the creditor of a contact
/{organizationId}/{mandateId}/crm/contacts/{contactId}/creditorList history
Returns contact history, optionally including the linked debtor and creditor history accessible to the caller
/{organizationId}/{mandateId}/crm/contacts/{contactId}/history/listExport contacts
Exports contacts for the organization/mandate
/{organizationId}/{mandateId}/crm/contacts/exportList tags
Returns a list of contact tags for the given organization
/{organizationId}/{mandateId}/crm/contacts/tags/listRemove tag
Removes a contact tag case-insensitively from all matching contacts in the organization and cleans dependent member booking restrictions and canonical contact tag usage.
/{organizationId}/crm/contacts/tags/removeUpdate stock report settings
Updates the stock report settings for the given department
/{organizationId}/crm/contacts/departments/{departmentId}/stockReportGet members stock report issues
Returns how many members are missing some settings to generate a stock report
/{organizationId}/{mandateId}/crm/contacts/getMembersStockReportIssuesExport members stock report
Exports the members stock report file
/{organizationId}/{mandateId}/crm/contacts/exportMembersStockReportSync from old contact
Given an old contact ID, synchronizes it into a contact.
/{organizationId}/crm/contacts/syncFromOldContact/{oldContactId}Send message to contacts
Send message to contacts for the organization/mandate
/{organizationId}/{mandateId}/crm/contacts/sendMessageTerminate membership for a contact
Terminates the membership for the given contact.
/{organizationId}/{mandateId}/crm/contacts/{contactId}/membership/terminateRevert membership termination for a contact
Reverts the membership termination for the given contact.
/{organizationId}/{mandateId}/crm/contacts/{contactId}/membership/revert-terminationBulk delete contacts
Deletes the given contacts and all of their data
/{organizationId}/{mandateId}/crm/contacts/bulkDeleteGet shared contact
Returns a specific shared contact for the organization
/{organizationId}/crm/contacts/shared/{contactId}List shared contacts
Returns a list of shared contacts for the organization
/{organizationId}/crm/contacts/shared/listExport shared contacts
Exports shared contacts for the organization
/{organizationId}/crm/contacts/shared/exportSend message to shared contacts
Send message to shared contacts
/{organizationId}/crm/contacts/shared/sendMessageUpdate shared contact tags
Updates shared contact tags for the organization
/{organizationId}/crm/contacts/shared/{contactId}/tagsUpdate shared contact custom fields
Updates parent organization custom fields on a shared contact
/{organizationId}/crm/contacts/shared/{contactId}/customFields