API Reference
Contact
Endpoints for working with Contact resources in klink.cloud. All requests are authenticated with your API token — see Authentication.
- GET/api/v1/contacts
Listing
This endpoint allows you to retrieve a paginated list of all your contacts. By default, a maximum of ten contacts are shown per page.
- POST/api/v1/contacts
Create
This endpoint allows you to add a new contact to your contact list in klink.cloud. To add a contact, you must provide their klink.cloud username and phone number.
- GET/api/v1/contacts/social-platform
Filter By SocialPlatformId
This endpoint allows you to retrieve a contact by providing their klink.cloud base on social media platform Id. Refer to the list at the top of this page to see which properties are included with contact objects.
- GET/api/v1/contacts/fields
Form Fields
This endpoint allows you to get available contact fields including the custom fields you have created.
- GET/api/v1/contacts/{id}
Detail
This endpoint allows you to retrieve a contact by providing their klink.cloud id. Refer to the list at the top of this page to see which properties are included with contact objects.
- PATCH/api/v1/contacts/{id}
Update
This endpoint allows you to perform an update on a contact.
- DELETE/api/v1/contacts/{id}
Delete
This endpoint allows you to delete contacts from your contact list in klink.cloud. Note: This will also delete your conversation with the given contact.
- GET/api/v1/contacts/groups
Fetch Contact Groups
This endpoint allows you to get contact groups. You can use this endpoint to get ids of contact groups to include in create contact endpoint.
- PATCH/api/v1/contacts/{id}/tags
Update tags
This endpoint allows you to perform an update only tags on a contact.
- GET/api/v1/contacts/phone/{phone}
Filter By Phone Number
Retrieve a single contact by phone number.