twentycrm_client.WorkflowsApi

All URIs are relative to https://crm.example.com/rest

Method	HTTP request	Description
create_many_workflows	POST /batch/workflows	Create Many workflows
create_one_workflow	POST /workflows	Create One workflow
delete_many_workflows	DELETE /workflows	Delete Many workflows
delete_one_workflow	DELETE /workflows/{id}	Delete One workflow
find_many_workflows	GET /workflows	Find Many workflows
find_one_workflow	GET /workflows/{id}	Find One workflow
find_workflow_duplicates	POST /workflows/duplicates	Find workflow Duplicates
group_by_workflows	GET /workflows/groupBy	Group By workflows
merge_many_workflows	PATCH /workflows/merge	Merge Many workflows
restore_many_workflows	PATCH /restore/workflows	Restore Many workflows
restore_one_workflow	PATCH /restore/workflows/{id}	Restore One workflow
update_many_workflows	PATCH /workflows	Update Many workflows
update_one_workflow	PATCH /workflows/{id}	Update One workflow

create_many_workflows

CreateManyWorkflows201Response create_many_workflows(workflow, depth=depth, upsert=upsert)

Create Many workflows

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.create_many_workflows201_response import CreateManyWorkflows201Response
from twentycrm_client.models.workflow import Workflow
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    workflow = [twentycrm_client.Workflow()] # List[Workflow] | 
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    upsert = False # bool | If true, creates the object or updates it if it already exists. (optional) (default to False)

    try:
        # Create Many workflows
        api_response = api_instance.create_many_workflows(workflow, depth=depth, upsert=upsert)
        print("The response of WorkflowsApi->create_many_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->create_many_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow	List[Workflow]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
upsert	bool	If true, creates the object or updates it if it already exists.	[optional] [default to False]

Return type

CreateManyWorkflows201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

create_one_workflow

CreateOneWorkflow201Response create_one_workflow(workflow, depth=depth, upsert=upsert)

Create One workflow

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.create_one_workflow201_response import CreateOneWorkflow201Response
from twentycrm_client.models.workflow import Workflow
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    workflow = twentycrm_client.Workflow() # Workflow | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    upsert = False # bool | If true, creates the object or updates it if it already exists. (optional) (default to False)

    try:
        # Create One workflow
        api_response = api_instance.create_one_workflow(workflow, depth=depth, upsert=upsert)
        print("The response of WorkflowsApi->create_one_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->create_one_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow	Workflow	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
upsert	bool	If true, creates the object or updates it if it already exists.	[optional] [default to False]

Return type

CreateOneWorkflow201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

delete_many_workflows

DeleteManyWorkflows200Response delete_many_workflows(filter=filter, soft_delete=soft_delete)

Delete Many workflows

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.delete_many_workflows200_response import DeleteManyWorkflows200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    soft_delete = False # bool | If true, soft deletes the objects. If false, objects are permanently deleted. (optional) (default to False)

    try:
        # Delete Many workflows
        api_response = api_instance.delete_many_workflows(filter=filter, soft_delete=soft_delete)
        print("The response of WorkflowsApi->delete_many_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->delete_many_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
soft_delete	bool	If true, soft deletes the objects. If false, objects are permanently deleted.	[optional] [default to False]

Return type

DeleteManyWorkflows200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

delete_one_workflow

DeleteOneWorkflow200Response delete_one_workflow(id, soft_delete=soft_delete)

Delete One workflow

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.delete_one_workflow200_response import DeleteOneWorkflow200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    soft_delete = False # bool | If true, soft deletes the objects. If false, objects are permanently deleted. (optional) (default to False)

    try:
        # Delete One workflow
        api_response = api_instance.delete_one_workflow(id, soft_delete=soft_delete)
        print("The response of WorkflowsApi->delete_one_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->delete_one_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
soft_delete	bool	If true, soft deletes the objects. If false, objects are permanently deleted.	[optional] [default to False]

Return type

DeleteOneWorkflow200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

find_many_workflows

FindManyWorkflows200Response find_many_workflows(order_by=order_by, filter=filter, limit=limit, depth=depth, starting_after=starting_after, ending_before=ending_before)

Find Many workflows

order_by, filter, limit, depth, starting_after or ending_before can be provided to request your workflows

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_many_workflows200_response import FindManyWorkflows200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    order_by = 'createdAt' # str | Format: **field_name_1,field_name_2[DIRECTION_2]     Refer to the filter section at the top of the page for more details. (optional)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    limit = 60 # int | Limits the number of objects returned. (optional) (default to 60)
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    starting_after = 'starting_after_example' # str | Returns objects starting after a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data (optional)
    ending_before = 'ending_before_example' # str | Returns objects ending before a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data (optional)

    try:
        # Find Many workflows
        api_response = api_instance.find_many_workflows(order_by=order_by, filter=filter, limit=limit, depth=depth, starting_after=starting_after, ending_before=ending_before)
        print("The response of WorkflowsApi->find_many_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->find_many_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_by	str	Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.	[optional]
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
limit	int	Limits the number of objects returned.	[optional] [default to 60]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
starting_after	str	Returns objects starting after a specific cursor. You can find cursors in startCursor and endCursor in pageInfo in response data	[optional]
ending_before	str	Returns objects ending before a specific cursor. You can find cursors in startCursor and endCursor in pageInfo in response data	[optional]

Return type

FindManyWorkflows200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

find_one_workflow

FindOneWorkflow200Response find_one_workflow(id, depth=depth)

Find One workflow

depth can be provided to request your workflow

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_one_workflow200_response import FindOneWorkflow200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Find One workflow
        api_response = api_instance.find_one_workflow(id, depth=depth)
        print("The response of WorkflowsApi->find_one_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->find_one_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

FindOneWorkflow200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

find_workflow_duplicates

FindWorkflowDuplicates200Response find_workflow_duplicates(find_workflow_duplicates_request, depth=depth)

Find workflow Duplicates

depth can be provided to request your workflow

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_workflow_duplicates200_response import FindWorkflowDuplicates200Response
from twentycrm_client.models.find_workflow_duplicates_request import FindWorkflowDuplicatesRequest
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    find_workflow_duplicates_request = twentycrm_client.FindWorkflowDuplicatesRequest() # FindWorkflowDuplicatesRequest | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Find workflow Duplicates
        api_response = api_instance.find_workflow_duplicates(find_workflow_duplicates_request, depth=depth)
        print("The response of WorkflowsApi->find_workflow_duplicates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->find_workflow_duplicates: %s\n" % e)

Parameters

Name	Type	Description	Notes
find_workflow_duplicates_request	FindWorkflowDuplicatesRequest	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

FindWorkflowDuplicates200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

group_by_workflows

GroupByWorkflows200Response group_by_workflows(group_by, filter=filter, order_by=order_by, limit=limit, view_id=view_id, aggregate=aggregate, include_records_sample=include_records_sample, order_by_for_records=order_by_for_records)

Group By workflows

Groups workflows by specified fields and optionally computes aggregate values for each group.

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.group_by_workflows200_response import GroupByWorkflows200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    group_by = '[{\"updatedAt\": true}]' # str | Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    order_by = 'createdAt' # str | Format: **field_name_1,field_name_2[DIRECTION_2]     Refer to the filter section at the top of the page for more details. (optional)
    limit = 60 # int | Limits the number of objects returned. (optional) (default to 60)
    view_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | View ID to apply filters from. (optional)
    aggregate = '[\"countNotEmptyId\"]' # str | Array of aggregate operations to compute for each group. (optional)
    include_records_sample = False # bool | If true, includes a sample of records for each group in the response. (optional) (default to False)
    order_by_for_records = 'createdAt' # str | Order by clause for records within each group. Only applicable when include_records_sample is true. (optional)

    try:
        # Group By workflows
        api_response = api_instance.group_by_workflows(group_by, filter=filter, order_by=order_by, limit=limit, view_id=view_id, aggregate=aggregate, include_records_sample=include_records_sample, order_by_for_records=order_by_for_records)
        print("The response of WorkflowsApi->group_by_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->group_by_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_by	str	Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
order_by	str	Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.	[optional]
limit	int	Limits the number of objects returned.	[optional] [default to 60]
view_id	UUID	View ID to apply filters from.	[optional]
aggregate	str	Array of aggregate operations to compute for each group.	[optional]
include_records_sample	bool	If true, includes a sample of records for each group in the response.	[optional] [default to False]
order_by_for_records	str	Order by clause for records within each group. Only applicable when include_records_sample is true.	[optional]

Return type

GroupByWorkflows200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

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

merge_many_workflows

MergeManyWorkflows200Response merge_many_workflows(merge_many_workflows_request, depth=depth)

Merge Many workflows

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.merge_many_workflows200_response import MergeManyWorkflows200Response
from twentycrm_client.models.merge_many_workflows_request import MergeManyWorkflowsRequest
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    merge_many_workflows_request = twentycrm_client.MergeManyWorkflowsRequest() # MergeManyWorkflowsRequest | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Merge Many workflows
        api_response = api_instance.merge_many_workflows(merge_many_workflows_request, depth=depth)
        print("The response of WorkflowsApi->merge_many_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->merge_many_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
merge_many_workflows_request	MergeManyWorkflowsRequest	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

MergeManyWorkflows200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

restore_many_workflows

RestoreManyWorkflows200Response restore_many_workflows(filter=filter, depth=depth)

Restore Many workflows

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.restore_many_workflows200_response import RestoreManyWorkflows200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Restore Many workflows
        api_response = api_instance.restore_many_workflows(filter=filter, depth=depth)
        print("The response of WorkflowsApi->restore_many_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->restore_many_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

RestoreManyWorkflows200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

restore_one_workflow

RestoreOneWorkflow200Response restore_one_workflow(id, depth=depth)

Restore One workflow

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.restore_one_workflow200_response import RestoreOneWorkflow200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Restore One workflow
        api_response = api_instance.restore_one_workflow(id, depth=depth)
        print("The response of WorkflowsApi->restore_one_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->restore_one_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

RestoreOneWorkflow200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

update_many_workflows

UpdateManyWorkflows200Response update_many_workflows(workflow_for_update, depth=depth, filter=filter)

Update Many workflows

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.update_many_workflows200_response import UpdateManyWorkflows200Response
from twentycrm_client.models.workflow_for_update import WorkflowForUpdate
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    workflow_for_update = twentycrm_client.WorkflowForUpdate() # WorkflowForUpdate | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)

    try:
        # Update Many workflows
        api_response = api_instance.update_many_workflows(workflow_for_update, depth=depth, filter=filter)
        print("The response of WorkflowsApi->update_many_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->update_many_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_for_update	WorkflowForUpdate	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]

Return type

UpdateManyWorkflows200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

update_one_workflow

UpdateOneWorkflow200Response update_one_workflow(id, workflow_for_update, depth=depth)

Update One workflow

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.update_one_workflow200_response import UpdateOneWorkflow200Response
from twentycrm_client.models.workflow_for_update import WorkflowForUpdate
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    workflow_for_update = twentycrm_client.WorkflowForUpdate() # WorkflowForUpdate | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Update One workflow
        api_response = api_instance.update_one_workflow(id, workflow_for_update, depth=depth)
        print("The response of WorkflowsApi->update_one_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowsApi->update_one_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
workflow_for_update	WorkflowForUpdate	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

UpdateOneWorkflow200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

Uh oh!

FilesExpand file tree

WorkflowsApi.md

Latest commit

History

WorkflowsApi.md

File metadata and controls

twentycrm_client.WorkflowsApi

create_many_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_one_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_many_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_one_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_many_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_one_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_workflow_duplicates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_by_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

merge_many_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_many_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_one_workflow

Example