Skip to content

ContactApi.md

Latest commit

 

History

History
123 lines (88 loc) · 3.94 KB

ContactApi.md

File metadata and controls

123 lines (88 loc) · 3.94 KB

chatwoot_client.ContactApi

All URIs are relative to https://app.chatwoot.com/

Method HTTP request Description
contact_inbox_creation POST /api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes Create contact inbox
contactable_inboxes_get GET /api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes Get Contactable Inboxes

contact_inbox_creation

ContactInboxes contact_inbox_creation(body, account_id, id)

Create contact inbox

Create a contact inbox record for an inbox

Example

from __future__ import print_function
import time
import chatwoot_client
from chatwoot_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
configuration = chatwoot_client.Configuration()
configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = chatwoot_client.ContactApi(chatwoot_client.ApiClient(configuration))
body = chatwoot_client.IdContactInboxesBody() # IdContactInboxesBody | 
account_id = 56 # int | The numeric ID of the account
id = 56 # int | ID of the contact

try:
    # Create contact inbox
    api_response = api_instance.contact_inbox_creation(body, account_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->contact_inbox_creation: %s\n" % e)

Parameters

Name Type Description Notes
body IdContactInboxesBody
account_id int The numeric ID of the account
id int ID of the contact

Return type

ContactInboxes

Authorization

userApiKey

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

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

contactable_inboxes_get

ContactableInboxes contactable_inboxes_get(account_id, id)

Get Contactable Inboxes

Get List of contactable Inboxes

Example

from __future__ import print_function
import time
import chatwoot_client
from chatwoot_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
configuration = chatwoot_client.Configuration()
configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = chatwoot_client.ContactApi(chatwoot_client.ApiClient(configuration))
account_id = 56 # int | The numeric ID of the account
id = 56 # int | ID of the contact

try:
    # Get Contactable Inboxes
    api_response = api_instance.contactable_inboxes_get(account_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->contactable_inboxes_get: %s\n" % e)

Parameters

Name Type Description Notes
account_id int The numeric ID of the account
id int ID of the contact

Return type

ContactableInboxes

Authorization

userApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

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