Skip to content
campaiDeveloper
campai.com

Contacts

Subcategories

API Endpoints

Create contact

Creates a new contact with a specific type

POST/{organizationId}/{mandateId}/crm/contacts

Get contact

Returns a specific contact with all of its details

GET/{organizationId}/{mandateId}/crm/contacts/{contactId}

Update contact

Updates basic contact information

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}

Delete contact

Deletes a given contact and all of its data

DELETE/{organizationId}/{mandateId}/crm/contacts/{contactId}

Get readable contact custom fields

Returns custom field definitions, including inherited fields, for readable contact types

GET/{organizationId}/crm/contacts/custom-fields

Gets suggested subscription plans for a contact

GET/{organizationId}/{mandateId}/crm/contacts/{contactId}/suggested-plans

Get data privacy information

Returns a PDF export with data privacy information for a contact

GET/{organizationId}/{mandateId}/crm/contacts/{contactId}/dataPrivacyInformation

List contacts celebrations

Returns a list of contacts for the mandate that are celebrating events like birthdays, anniversaries, leaving or joining the membership

POST/{organizationId}/{mandateId}/crm/contacts/listContactsCelebrations

Export contacts celebrations

Exports a list of contacts for the mandate that are celebrating events like birthdays, anniversaries, leaving or joining the membership

POST/{organizationId}/{mandateId}/crm/contacts/exportContactsCelebrations

List contacts

Returns a list of contacts for the mandate

POST/{organizationId}/{mandateId}/crm/contacts/list

Unclaim contact

Removes the connected user from a specific contact

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/unclaim

Add contact type

Adds an additional type to an existing contact

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/types/add

Preview contact type removal

Checks removal permissions in every contact mandate and reports blockers and consequences without changing the contact.

GET/{organizationId}/{mandateId}/crm/contacts/{contactId}/types/{type}/removal-impact

Remove 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.

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/types/remove

Change contact debtor

Changes the debtor of a contact

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/debtor

Change contact creditor

Changes the creditor of a contact

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/creditor

List history

Returns contact history, optionally including the linked debtor and creditor history accessible to the caller

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/history/list

Export contacts

Exports contacts for the organization/mandate

POST/{organizationId}/{mandateId}/crm/contacts/export

List tags

Returns a list of contact tags for the given organization

POST/{organizationId}/{mandateId}/crm/contacts/tags/list

Remove 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.

POST/{organizationId}/crm/contacts/tags/remove

Update stock report settings

Updates the stock report settings for the given department

POST/{organizationId}/crm/contacts/departments/{departmentId}/stockReport

Get members stock report issues

Returns how many members are missing some settings to generate a stock report

POST/{organizationId}/{mandateId}/crm/contacts/getMembersStockReportIssues

Export members stock report

Exports the members stock report file

POST/{organizationId}/{mandateId}/crm/contacts/exportMembersStockReport

Sync from old contact

Given an old contact ID, synchronizes it into a contact.

POST/{organizationId}/crm/contacts/syncFromOldContact/{oldContactId}

Send message to contacts

Send message to contacts for the organization/mandate

POST/{organizationId}/{mandateId}/crm/contacts/sendMessage

Terminate membership for a contact

Terminates the membership for the given contact.

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/membership/terminate

Revert membership termination for a contact

Reverts the membership termination for the given contact.

POST/{organizationId}/{mandateId}/crm/contacts/{contactId}/membership/revert-termination

Bulk delete contacts

Deletes the given contacts and all of their data

POST/{organizationId}/{mandateId}/crm/contacts/bulkDelete

Get shared contact

Returns a specific shared contact for the organization

GET/{organizationId}/crm/contacts/shared/{contactId}

List shared contacts

Returns a list of shared contacts for the organization

POST/{organizationId}/crm/contacts/shared/list

Export shared contacts

Exports shared contacts for the organization

POST/{organizationId}/crm/contacts/shared/export

Send message to shared contacts

Send message to shared contacts

POST/{organizationId}/crm/contacts/shared/sendMessage

Update shared contact tags

Updates shared contact tags for the organization

POST/{organizationId}/crm/contacts/shared/{contactId}/tags

Update shared contact custom fields

Updates parent organization custom fields on a shared contact

POST/{organizationId}/crm/contacts/shared/{contactId}/customFields