Skip to content

Latest commit

 

History

History
150 lines (101 loc) · 8.57 KB

README.md

File metadata and controls

150 lines (101 loc) · 8.57 KB
Raw

Tasks

(crm.tasks)

Available Operations

list

List Tasks

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.crm.tasks.list(x_connection_token="<value>", remote_data=True, limit=10, cursor="1b8b05bb-5273-4012-b520-8657b0b90874")

if res is not None:
    while True:
        # handle items

        res = res.Next()
        if res is None:
            break

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
remote_data Optional[bool] ➖ Set to true to include data from the original software. true
limit Optional[float] ➖ Set to get the number of records. 10
cursor Optional[str] ➖ Set to get the number of records after this cursor. 1b8b05bb-5273-4012-b520-8657b0b90874
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListCrmTaskResponse

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

create

Create Tasks in any supported Crm software

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.crm.tasks.create(x_connection_token="<value>", unified_crm_task_input={
    "subject": "Answer customers",
    "content": "Prepare email campaign",
    "status": "PENDING",
    "due_date": "2024-10-01T12:00:00Z",
    "finished_date": "2024-10-01T12:00:00Z",
    "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "deal_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red",
    },
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
x_connection_token str ✔️ The connection token
unified_crm_task_input models.UnifiedCrmTaskInput ✔️ N/A
remote_data Optional[bool] ➖ Set to true to include data from the original Crm software.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedCrmTaskOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

retrieve

Retrieve Tasks from any connected Crm software

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.crm.tasks.retrieve(x_connection_token="<value>", id="801f9ede-c698-4e66-a7fc-48d19eebaa4f", remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
id str ✔️ id of the task you want to retrieve. 801f9ede-c698-4e66-a7fc-48d19eebaa4f
remote_data Optional[bool] ➖ Set to true to include data from the original Crm software. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedCrmTaskOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /