Contacts

Individual contact management endpoints

Create contact

post

Create a new contact in a contact group

Authorizations
AuthorizationstringRequired
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
post
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/create/

List contacts

get

Get all contacts in a specific contact group

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

Contact details

get

Get, update, or delete a specific contact

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

Contact details

put

Get, update, or delete a specific contact

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

Contact details

delete

Get, update, or delete a specific contact

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

Contact details

patch

Get, update, or delete a specific contact

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