πŸ“ Contact Groups

Organize contacts into groups and categories

Create contact group

post
/api/v1.0/organisation/{unique_id}/contact-groups/create/

Create a new contact group in the organisation. Group Name is required.

Authorizations
sessionidstringRequired
Path parameters
unique_idstringRequired
Body

Serializer for ContactGroup model supporting both creation and listing. Handles multilingual fields through parler TranslatableModelSerializer.

unique_idstring Β· max: 100 Β· nullableOptional
namestring Β· min: 1 Β· max: 200Required
descriptionstring Β· nullableOptional
translationsstringRequired
is_activebooleanOptional
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
Responses
post
/api/v1.0/organisation/{unique_id}/contact-groups/create/

List contact groups

get
/api/v1.0/organisation/{unique_id}/contact-groups/

Get all contact groups for an organisation

Authorizations
sessionidstringRequired
Path parameters
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/
200Success

Contact group details

get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Retrieve full information about a specific contact group.

Authorizations
sessionidstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Update contact group (full)

put
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Replace all editable fields of a contact group. Provide the full payload.

Authorizations
sessionidstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Body

Serializer for ContactGroup model supporting both creation and listing. Handles multilingual fields through parler TranslatableModelSerializer.

unique_idstring Β· max: 100 Β· nullableOptional
namestring Β· min: 1 Β· max: 200Required
descriptionstring Β· nullableOptional
translationsstringRequired
is_activebooleanOptional
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Delete contact group

delete
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Delete a specific contact group from the organisation.

Authorizations
sessionidstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
chevron-right
200

Contact group deleted

No content

delete
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

No content

Update contact group (partial)

patch
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Partially update a contact group. Send only the fields that need changes.

Authorizations
sessionidstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Body

Serializer for ContactGroup model supporting both creation and listing. Handles multilingual fields through parler TranslatableModelSerializer.

unique_idstring Β· max: 100 Β· nullableOptional
namestring Β· min: 1 Β· max: 200Optional
descriptionstring Β· nullableOptional
translationsstringOptional
is_activebooleanOptional
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

Create contact

post
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/create/

Create a new contact in a contact group. First name, last name, and entity type are required.

Authorizations
sessionidstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Contact model. Handles contact creation, updates, and group assignment.

unique_idstring Β· max: 100 Β· nullableOptional
translationsstringRequired
contact_groupstring Β· nullableOptional

Contact group unique_id (optional - can be assigned later)

entity_typestring Β· enumRequired

Type of entity (client, vendor, lead)

  • client - Client
  • vendor - Vendor
  • lead - Lead
Possible values:
entity_idstring Β· max: 100 Β· nullableOptional

ID of the entity this contact belongs to (optional for potential clients/vendors)

first_namestring Β· min: 1 Β· max: 150Required
last_namestring Β· min: 1 Β· max: 150Required
emailstring Β· email Β· max: 254 Β· nullableOptional
phonestring Β· max: 17 Β· nullableOptional
mobilestring Β· max: 17 Β· nullableOptional
linkedin_urlstring Β· uri Β· max: 200 Β· nullableOptional

LinkedIn profile URL

job_titlestring Β· nullableOptional
departmentstring Β· nullableOptional
notesstring Β· nullableOptional
is_activebooleanOptional
primary_contactbooleanOptional

Indicates if this is the primary contact for the entity

date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
Responses
post
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/create/

List contacts

get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/

Get all contacts in a specific contact group with optional filters

Authorizations
sessionidstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Query parameters
entity_typestring Β· enumOptional

Filter by entity type

Possible values:
is_activestringOptional

Filter by active status (true/false)

searchstringOptional

Search contacts by first name, last name, email, or phone

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/

Contact details

get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/

Get a specific contact inside a group.

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/

Update contact

put
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/update/

Update a specific contact in a contact group (full or partial update)

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Contact model. Handles contact creation, updates, and group assignment.

unique_idstring Β· max: 100 Β· nullableOptional
translationsstringRequired
contact_groupstring Β· nullableOptional

Contact group unique_id (optional - can be assigned later)

entity_typestring Β· enumRequired

Type of entity (client, vendor, lead)

  • client - Client
  • vendor - Vendor
  • lead - Lead
Possible values:
entity_idstring Β· max: 100 Β· nullableOptional

ID of the entity this contact belongs to (optional for potential clients/vendors)

first_namestring Β· min: 1 Β· max: 150Required
last_namestring Β· min: 1 Β· max: 150Required
emailstring Β· email Β· max: 254 Β· nullableOptional
phonestring Β· max: 17 Β· nullableOptional
mobilestring Β· max: 17 Β· nullableOptional
linkedin_urlstring Β· uri Β· max: 200 Β· nullableOptional

LinkedIn profile URL

job_titlestring Β· nullableOptional
departmentstring Β· nullableOptional
notesstring Β· nullableOptional
is_activebooleanOptional
primary_contactbooleanOptional

Indicates if this is the primary contact for the entity

date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/update/

Update contact

patch
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/update/

Update a specific contact in a contact group (full or partial update)

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Contact model. Handles contact creation, updates, and group assignment.

unique_idstring Β· max: 100 Β· nullableOptional
translationsstringOptional
contact_groupstring Β· nullableOptional

Contact group unique_id (optional - can be assigned later)

entity_typestring Β· enumOptional

Type of entity (client, vendor, lead)

  • client - Client
  • vendor - Vendor
  • lead - Lead
Possible values:
entity_idstring Β· max: 100 Β· nullableOptional

ID of the entity this contact belongs to (optional for potential clients/vendors)

first_namestring Β· min: 1 Β· max: 150Optional
last_namestring Β· min: 1 Β· max: 150Optional
emailstring Β· email Β· max: 254 Β· nullableOptional
phonestring Β· max: 17 Β· nullableOptional
mobilestring Β· max: 17 Β· nullableOptional
linkedin_urlstring Β· uri Β· max: 200 Β· nullableOptional

LinkedIn profile URL

job_titlestring Β· nullableOptional
departmentstring Β· nullableOptional
notesstring Β· nullableOptional
is_activebooleanOptional
primary_contactbooleanOptional

Indicates if this is the primary contact for the entity

date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/update/

Delete contact

delete
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/delete/

Delete a specific contact from a contact group

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Responses
delete
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/delete/

No content

Last updated