Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zavu Contacts API

The Contacts API from Zavu — 8 operation(s) for contacts.

Zavu Contacts API is one of 21 APIs that Zavu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 12 operations across 8 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 0.2.0.

Requests are made against a single base URL, https://api.zavu.dev.

12 operations 8 paths 10 schemas 3 DELETE3 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.2.0
Base URL
https://api.zavu.dev/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zavu Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 3 DELETE, 3 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Contacts 12
GET
/v1/contacts
List contacts
listContacts 3 params → 200401
POST
/v1/contacts
Create contact
createContact body → 201400401
GET
/v1/contacts/{contactId}
Get contact
getContact 1 param → 200401404
PATCH
/v1/contacts/{contactId}
Update contact
updateContact 1 param body → 200400401404
DELETE
/v1/contacts/{contactId}
Delete contact
deleteContact 1 param → 204401404
GET
/v1/contacts/phone/{phoneNumber}
Get contact by phone number
getContactByPhone 1 param → 200401404
POST
/v1/contacts/{contactId}/channels
Add channel to contact
addContactChannel 1 param body → 201400401404
PATCH
/v1/contacts/{contactId}/channels/{channelId}
Update channel
updateContactChannel 2 params body → 200400401404
DELETE
/v1/contacts/{contactId}/channels/{channelId}
Remove channel from contact
removeContactChannel 2 params → 204400401404
POST
/v1/contacts/{contactId}/channels/{channelId}/primary
Set channel as primary
setPrimaryChannel 2 params → 200401404
POST
/v1/contacts/{contactId}/merge
Merge contacts
mergeContacts 1 param body → 200400401404
DELETE
/v1/contacts/{contactId}/merge-suggestion
Dismiss merge suggestion
dismissMergeSuggestion 1 param → 204401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Contact (15 properties), ContactChannel (12 properties), ContactChannelInput (5 properties), AddChannelRequest (5 properties). Each schema is shown below with its type and property counts.

UpdateChannelRequest
object
Request body to update a channel.
3 properties
ContactChannelInput
object
Input for creating a contact channel.
5 properties 2 required
ContactChannelResponse
object
1 property 1 required
MergeContactsRequest
object
Request body to merge contacts.
1 property 1 required
ContactUpdateRequest
object
2 properties
ContactChannel
object
A communication channel for a contact.
12 properties 6 required
Contact
object
15 properties 5 required
Error
object
3 properties 2 required
ContactCreateRequest
object
Request body to create a contact with channels.
3 properties 1 required
AddChannelRequest
object
Request body to add a channel to a contact.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zavu-contacts-api-openapi.yml Raw ↑

Other APIs Zavu publishes across the network.

Zavu 10DLC API
Zavu Account API
Zavu Agent Flows API
Zavu Agent Knowledge Bases API
Zavu Agent Tools API
Zavu Agents API
Zavu Balance API
Zavu Broadcasts API
Zavu Functions API
Zavu Introspect API
Zavu Invitations API
Zavu Messages API