Skip to content

Latest commit

 

History

History
224 lines (126 loc) · 6.64 KB

File metadata and controls

224 lines (126 loc) · 6.64 KB

\ContactsApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
bulk_create_contacts POST /v1/contacts/bulk Bulk create contacts
create_contact POST /v1/contacts Create a contact
delete_contact DELETE /v1/contacts/{contactId} Delete a contact
get_contact GET /v1/contacts/{contactId} Get contact with channels
get_contact_channels GET /v1/contacts/{contactId}/channels List channels for a contact
list_contacts GET /v1/contacts List contacts
update_contact PATCH /v1/contacts/{contactId} Update a contact

bulk_create_contacts

models::BulkCreateContacts200Response bulk_create_contacts(bulk_create_contacts_request) Bulk create contacts

Import up to 1000 contacts at a time. Skips duplicates.

Parameters

Name Type Description Required Notes
bulk_create_contacts_request BulkCreateContactsRequest [required]

Return type

models::BulkCreateContacts200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_contact

models::CreateContact200Response create_contact(create_contact_request) Create a contact

Create a new contact. Optionally create a platform channel in the same request by providing accountId, platform, and platformIdentifier.

Parameters

Name Type Description Required Notes
create_contact_request CreateContactRequest [required]

Return type

models::CreateContact200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_contact

delete_contact(contact_id) Delete a contact

Parameters

Name Type Description Required Notes
contact_id String [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_contact

models::GetContact200Response get_contact(contact_id) Get contact with channels

Parameters

Name Type Description Required Notes
contact_id String [required]

Return type

models::GetContact200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_contact_channels

models::GetContactChannels200Response get_contact_channels(contact_id) List channels for a contact

Parameters

Name Type Description Required Notes
contact_id String [required]

Return type

models::GetContactChannels200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_contacts

models::ListContacts200Response list_contacts(profile_id, search, tag, platform, is_subscribed, limit, skip) List contacts

List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and full-text search.

Parameters

Name Type Description Required Notes
profile_id Option<String> Filter by profile. Omit to list across all profiles
search Option<String>
tag Option<String>
platform Option<String>
is_subscribed Option<String>
limit Option<i32> [default to 50]
skip Option<i32> [default to 0]

Return type

models::ListContacts200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_contact

models::UpdateContact200Response update_contact(contact_id, update_contact_request) Update a contact

Parameters

Name Type Description Required Notes
contact_id String [required]
update_contact_request Option<UpdateContactRequest>

Return type

models::UpdateContact200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]