Connectors Reference
Tilkee is an online platform that makes cross-functional collaboration happen. Combining deep knowledge of sales enablement with augmented intelligence, the vision of the team behind Tilkee is to align marketing with sales and guide Sales, Product Marketing, Channel Enablement, and Customer Success teams towards digital transformation.
|
Status: Preview |
Tier: Premium |
Version: 1.1 |
|
Name |
Summary |
|
Create a project, add document(s) and retrieve access link(s) |
|
|
List and search projects or templates |
|
|
Get project information |
|
|
Update a project (verdict, consultable, downloadable...) |
|
|
Create access link(s) |
|
|
Add item(s) to a specific project |
|
|
List and search items |
|
|
Create an item |
|
|
Upload information |
|
Name |
Summary |
|
Subscribe to a Tilkee event |
|
|
Subscribe to end of connexion Tilkee event |
|
|
Subscribe to signature Tilkee event |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Create a project, add document(s) and retrieve access link(s)
Description: Create a project, add document(s) and retrieve access link(s) from this endpoint
Syntax:
Tilkee.ProjectCreate ([internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, [Optional]ProjectCreateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Summary: List and search projects or templates
Description: List or search for project or template
Syntax:
Tilkee.ProjectList ([advanced]integer limit, [advanced]integer offset, [advanced]string order, boolean is_template, [Optional]string tags, [advanced][Optional]string tagOperator, boolean is_owner, [Optional]string search, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
limit |
integer (Limit) |
number of results |
True |
|
|
offset |
integer (Offset) |
offset |
True |
|
|
order |
string (Order) |
Sorting order (-created_at to order by creation date desc) |
True |
|
|
is_template |
boolean (Templates only) |
TRUE to retrieve only templates |
True |
|
|
tags |
string (Tag(s)) |
Add tags (coma separated) to search projects by tag |
False |
|
|
tagOperator |
string (tagOperator) |
Use AND (default) to retrieve projects with all tags, OR to retrieve projects with any of the provided tags |
False |
|
|
is_owner |
boolean (My projects ony) |
TRUE to retrieve only my projects (no projects from other users) |
True |
|
|
search |
string (Search text) |
Search for any text in project's or link's name |
False |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
Returns:
Type:ProjectListResponse
Summary: Get project information
Description: Get project information
Syntax:
Tilkee.ProjectGet (string id, [internal]boolean iframe_url, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Project id) |
Tilkee internal id of the project |
True |
|
|
iframe_url |
boolean (iframe_url) |
number of results |
True |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
Returns:
Type:ProjectGetResponse
Summary: Update a project (verdict, consultable, downloadable...)
Description: Update a project (verdict, consultable, downloadable...)
Syntax:
Tilkee.ProjectUpdate (string id, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, ProjectUpdateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Project id) |
Tilkee internal id of the project to update |
True |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: Create access link(s)
Description: Create access link(s) in a specific project
Syntax:
Tilkee.AccessLinkCreate (string project_id, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, AccessLinkCreateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
project_id |
string (Project id) |
Tilkee internal id of the project to add links to |
True |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: Add item(s) to a specific project
Description: Add one or mutiple items to a specific project
Syntax:
Tilkee.AddItemToProject (string project_id, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, AddItemToProjectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
project_id |
string (Project ID) |
Tilkee internal id of the project to add documents to |
True |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Type:array of (AddItemToProjectResponseItem)
Summary: List and search items
Description: List or search for items
Syntax:
Tilkee.ItemList ([advanced]integer limit, [advanced]integer offset, [Optional]string tags, [advanced][Optional]string tagOperator, [Optional]string search, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
limit |
integer (Limit) |
number of results |
True |
|
|
offset |
integer (Offset) |
Offset |
True |
|
|
tags |
string (Tag(s)) |
Add tags (coma separated) to search items |
False |
|
|
tagOperator |
string (tagOperator) |
Use AND (default) to retrieve items with all tags, OR to retrieve items with any of the provided tags |
False |
|
|
search |
string (Search text) |
Search for any text in document's name |
False |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
Returns:
Type:ItemListResponse
Summary: Create an item
Description: Create a new item before adding it to a project
Syntax:
Tilkee.ItemCreate ([internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, array body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
array of (ItemCreateParameterBodyItem) (Item) |
Item |
True |
Returns:
Type:array of (ItemCreateResponseItem)Item
Title: Item
Description: Item
Summary: Upload information
Description: Retrieve S3 upload information to upload file in Tilkee's platform. After retrieving this info, you should POST your file to 's3_endpoint, with key, acl, policy, signature & AWSAccessKeyId parameters. Amazon’s response is the URL you need to create your item in Tilkee.
Syntax:
Tilkee.DirectUploadInformation (string filename, string original_filename, [advanced][Optional]boolean check_existing, [internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
filename |
string (Filename with extension) |
Filename, with extension |
True |
|
|
original_filename |
string (Filename without extension) |
Filename, without extension |
True |
|
|
check_existing |
boolean (Check if file exists) |
Check existing files with same name? |
False |
|
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
Returns:
Type:DirectUploadInformationResponse
Summary: Subscribe to a Tilkee event
Description: Trigger your Flow when this event is triggered in Tilkee
Syntax:
Tilkee.OnTilkeeEvent ([internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, OnTilkeeEventParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary: Subscribe to end of connexion Tilkee event
Description: Trigger your flow after connexion on a Tilkee project
Syntax:
Tilkee.OnTilkeeEventEnded ([internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, OnTilkeeEventEndedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
OnTilkeeEventEndedParameterBody
|
|
True |
Returns:
Type:OnTilkeeEventEndedResponse
Summary: Subscribe to signature Tilkee event
Description: Trigger your flow when a Tilkee project is signed
Syntax:
Tilkee.OnTilkeeEventSigned ([internal]string Content-Type, [internal]string Accept, [internal]string x_tilk_ref, OnTilkeeEventSignedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Accept |
string
|
|
True |
|
|
x_tilk_ref |
string
|
|
True |
|
|
body |
OnTilkeeEventSignedParameterBody
|
|
True |
Returns:
Type:OnTilkeeEventSignedResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
persons |
array of (PersonsItem) Access link |
Access link |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name of the unique generated link |
|
external_id |
string
|
ID of the contact in your system |
|
external_data |
|
Specific information to be added in case of eSignature and form PDFs |
Summary:
Description: Specific information to be added in case of eSignature and form PDFs
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contents |
array of (ContentsItem)
|
Link |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
link |
string
|
|
|
external_id |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (ItemsItem)
|
Documents to add to the project. Must be items, created using Tilkee'API |
|
type |
string
|
Item's type. Only ProjectItem allowed |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string
|
Document's title |
|
id |
integer(int32)
|
Unique id retrieved from /items call |
|
downloadable |
boolean
|
TRUE if the document can be downloaded |
|
signable |
boolean
|
TRUE if the document can be signed (for PDFs only) |
|
watermark |
string
|
Text & position to watermark on document (pdf only) |
Summary:
Description: Project item
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project item id |
|
type |
string
|
Project item type |
|
element_id |
integer(int32)
|
Project item element_id |
|
title |
string
|
Project item title |
|
signable |
boolean
|
Project item signable? |
|
downloadable |
boolean
|
Project item downloadable? |
|
item |
|
Item |
Summary:
Description: Item
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Item id |
|
title |
string
|
Item title |
|
usable |
boolean
|
Item usable? |
|
extension |
string
|
Item extension |
|
type |
string
|
Item type |
|
external_id |
string
|
Item external_id |
|
tags |
array of (string)
|
Item tags |
|
favorite |
boolean
|
Item favorite? |
|
file_version |
integer(int32)
|
Item file_version |
|
replaced_at |
string
|
Item replaced_at |
|
file_size |
integer(int32)
|
Item file_size |
|
num_pages |
integer
|
Item num_pages |
|
convert_status |
|
convert_status |
|
s3_url |
string
|
Item url |
|
content_url |
string
|
Item content_url |
|
thumbnail_url |
string
|
Item thumbnail_url |
|
visible |
boolean
|
Item visible? |
|
created_at |
string
|
Item created_at |
Summary:
Description: convert_status
Properties:
|
Name |
Type |
Summary |
|
complete_base |
boolean
|
Item complete_base |
|
complete_full |
boolean
|
Item complete_full |
|
status |
array of (string)
|
Item convert status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
key |
string
|
|
|
acl |
string
|
|
|
policy |
string
|
|
|
signature |
string
|
|
|
AWSAccessKeyId |
string
|
|
|
success_action_status |
string
|
|
|
s3_endpoint |
string
|
|
|
name |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
Choose between File, Text and Link Values: [file, text, link] |
|
url |
string
|
When type=link: accessible URL, which will be displayed in an iFrame |
|
s3_url |
string
|
When type=file: accessible URL of the document (retrieved after posting a file using direct upload route. |
|
content |
string
|
When type=text: HTML content that will be displayed in viewer |
|
title |
string
|
To be used with TEXT and LINK items only |
|
name |
string
|
To be used with FILE items only |
|
external_id |
string
|
ID of the contact in your system |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
title |
string
|
|
|
usable |
boolean
|
|
|
element_type |
string
|
|
|
extension |
string
|
|
|
type |
string
|
|
|
external_id |
string
|
|
|
tags |
array of (string)
|
|
|
favorite |
boolean
|
|
|
file_version |
integer(int32)
|
|
|
visible |
boolean
|
|
|
thumbnail_url |
string
|
|
|
created_at |
string
|
|
|
updated_at |
string
|
|
|
replaced_at |
string
|
|
|
s3_url |
string
|
|
|
content_url |
string
|
|
|
convert_status |
|
|
|
owner |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
complete_base |
boolean
|
|
|
complete_full |
boolean
|
|
|
status |
array of (StatusItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
first_name |
string
|
|
|
last_name |
string
|
|
|
id |
integer(int32)
|
|
|
|
string
|
|
|
avatar |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
search |
string
|
|
|
limit |
integer(int32)
|
|
|
offset |
integer(int32)
|
|
|
order |
string
|
|
|
contents |
array of (ContentsItem)
|
|
Summary:
Description: Item
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
title |
string
|
|
|
usable |
boolean
|
|
|
element_type |
string
|
|
|
extension |
string
|
|
|
type |
string
|
|
|
external_id |
string
|
|
|
tags |
array of (string)
|
|
|
favorite |
boolean
|
|
|
file_version |
integer(int32)
|
|
|
num_pages |
integer(int32)
|
|
|
visible |
boolean
|
|
|
thumbnail_url |
string
|
|
|
created_at |
string
|
|
|
updated_at |
string
|
|
|
replaced_at |
string
|
|
|
s3_url |
string
|
|
|
content_url |
string
|
|
|
convert_status |
|
|
|
owner |
|
|
|
projects |
array of (ProjectsItem)
|
|
|
projects_count |
integer(int32)
|
|
|
content |
string
|
|
|
thumbnail_page_url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
complete_base |
boolean
|
|
|
complete_full |
boolean
|
|
|
status |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
first_name |
string
|
|
|
last_name |
string
|
|
|
id |
integer(int32)
|
|
|
|
string
|
|
|
avatar |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
is_template |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
rule |
string
|
connexion_ended |
|
user_id |
string
|
Only send notifications for this user's projects |
|
project_id |
string
|
Only send notifications for this projects |
|
url |
string
|
Url to send notifications to |
|
target |
string
|
target |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
rule |
string
|
Any of connexion_started, connexion_ended, token_signed, token_created, project_archived, unactivated_project_accessed, user_created Values: [connexion_started, connexion_ended, token_signed, token_created, project_archived, unactivated_project_accessed, user_created] |
|
user_id |
string
|
Only send notifications for this user's projects |
|
project_id |
string
|
Only send notifications for this projects |
|
url |
string
|
Url to send notifications to |
|
target |
string
|
target |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
rule |
string
|
token_signed |
|
user_id |
string
|
Only send notifications for this user's projects |
|
project_id |
string
|
Only send notifications for this projects |
|
url |
string
|
Url to send notifications to |
|
target |
string
|
target |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
project |
|
Project information |
|
documents |
array of (DocumentsItem)
|
Documents to add to the project |
|
person |
array of (PersonItem)
|
Access link(s) |
Summary:
Description: Project information
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id of an existing project that will be duplicated |
|
name |
string
|
Project name |
|
can_be_downloaded |
boolean
|
TRUE if the documents can be downloaded |
|
consultable |
boolean
|
TRUE if the project is consultable |
|
consultable_until |
string
|
Allow consultation until this date |
|
tags |
array of (string)
|
Tags to add to this project (array of string(s)) |
|
collaborators |
array of (CollaboratorsItem)
|
Collaborators to add to this project (array of id(s)) |
|
is_template |
boolean
|
TRUE if this project will be used as a template |
|
external_id |
string
|
Your internal id |
|
theme |
|
Theme (logo/colors) to be used for this project |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Theme (logo/colors) to be used for this project
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
An ID of theme |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
s3_url |
string
|
Accessible URL of the document. This URL is retrieved after posting a file using ITEMS route OR by providing a public allowed URL, with from_url=TRUE |
|
content |
string
|
Base64 encoded content - must include MIME : data:file/pdf;base64, |
|
signable |
boolean
|
TRUE if the document can be signed - used ONLY with PDF files |
|
from_url |
boolean
|
TRUE if Document URL is external to Tilkee |
|
external_id |
string
|
ID of the contact in your system |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name of the unique generated link |
|
external_id |
string
|
ID of the contact in your system |
|
external_data |
|
Specific information to be added in case of eSignature and form PDFs |
Summary:
Description: Specific information to be added in case of eSignature and form PDFs
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
project |
|
|
|
tokens |
array of (TokensItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
preview_url |
string
|
|
|
external_id |
string
|
|
|
url |
string
|
available only with Marketing option |
|
iframes |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
project_escape |
string
|
|
|
tokens_escape |
string
|
|
|
stats_escape |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
link |
string
|
|
|
external_id |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project id |
|
name |
string
|
Project name |
|
consultable |
boolean
|
TRUE if the project if consultable |
|
verdict |
string
|
Verdict of the project (won/lost/na) |
|
is_template |
boolean
|
TRUE if this project will be used as a template |
|
can_be_downloaded |
boolean
|
TRUE if the documents can be downloaded |
|
preview_new |
string
|
|
|
duration |
string
|
Used only for templates, you can create projects from this template that will expire xx days later. |
|
starred |
boolean
|
TRUE if is a starred project |
|
external_id |
string
|
Project external_id |
|
url |
string
|
Project authentication url |
|
signed |
boolean
|
Project signed? |
|
signable |
boolean
|
Project signable? |
|
tags |
array of (string)
|
Project tags |
|
vcard_id |
integer(int32)
|
Project vcard_id |
|
email_cible |
array of (string)
|
Project email_cible |
|
alert_on |
boolean
|
Project alert_on |
|
created_at |
string
|
|
|
updated_at |
string
|
|
|
consultable_until |
string
|
Allow consultation until this date |
|
last_sign_in_at |
string
|
|
|
first_access_at |
string
|
|
|
collaborators_count |
integer(int32)
|
|
|
convert_status |
|
Project convert_status |
|
nb_connections |
integer(int32)
|
|
|
total_time |
integer(int32)
|
|
|
theme |
|
Project theme |
|
iframes |
|
Project iFrames |
|
tokens_count |
integer(int32)
|
|
|
project_items_count |
integer(int32)
|
|
|
nb_used_as_template |
integer(int32)
|
|
|
email_templates_count |
integer(int32)
|
|
Summary:
Description: Project convert_status
Properties:
|
Name |
Type |
Summary |
|
complete_base |
boolean
|
|
|
complete_full |
boolean
|
|
Summary:
Description: Project theme
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project theme id |
|
name |
string
|
Project theme name |
Summary:
Description: Project iFrames
Properties:
|
Name |
Type |
Summary |
|
project_escape |
string
|
Project edit |
|
tokens_escape |
string
|
Project links |
|
stats_escape |
string
|
Project stats |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
search |
string
|
|
|
limit |
integer(int32)
|
|
|
offset |
integer(int32)
|
|
|
total |
integer(int32)
|
|
|
order |
string
|
|
|
contents |
array of (ContentsItem)
|
Project |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
|
|
name |
string
|
|
|
verdict |
string
|
|
|
is_template |
boolean
|
|
|
can_be_downloaded |
boolean
|
|
|
preview_new |
string
|
|
|
duration |
string
|
|
|
starred |
boolean
|
|
|
external_id |
string
|
|
|
url |
string
|
|
|
signed |
boolean
|
|
|
signable |
boolean
|
|
|
consultable |
boolean
|
|
|
tags |
array of (string)
|
|
|
pt_note |
number(float)
|
|
|
pt_accuracy |
string
|
|
|
pt_won |
boolean
|
|
|
vcard_id |
integer(int32)
|
|
|
email_cible |
array of (string)
|
|
|
alert_on |
boolean
|
|
|
created_at |
string
|
|
|
updated_at |
string
|
|
|
consultable_until |
string
|
|
|
last_sign_in_at |
string
|
|
|
first_access_at |
string
|
|
|
collaborators_count |
integer(int32)
|
|
|
convert_status |
|
|
|
nb_connections |
integer(int32)
|
|
|
total_time |
integer(int32)
|
|
|
leader_first_name |
string
|
|
|
leader_last_name |
string
|
|
|
leader_id |
integer(int32)
|
|
|
leader_email |
string
|
|
|
leader_avatar |
string
|
|
|
tokens_count |
integer(int32)
|
|
|
project_items_count |
integer(int32)
|
|
|
nb_used_as_template |
integer(int32)
|
|
|
email_templates_count |
integer(int32)
|
|
|
can_edit |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
complete_base |
boolean
|
|
|
complete_full |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Project name |
|
can_be_downloaded |
boolean
|
TRUE if the documents can be downloaded |
|
consultable |
boolean
|
TRUE if the project if consultable |
|
consultable_until |
string
|
Allow consultation until this date |
|
duration |
string
|
Used only for templates, you can create projects from this template that will expire xx days later. |
|
external_id |
string
|
external_id |
|
starred |
boolean
|
TRUE if is a starred project |
|
tags |
array of (string)
|
Tags to add to this project (array of string(s)) |
|
verdict |
string
|
Verdict of the project (won/lost/na) Values: [won, lost, na, nc] |
|
collaborators |
array of (CollaboratorsItem)
|
Collaborators to add to this project (array of id(s)) |
|
is_template |
boolean
|
TRUE if this project will be used as a template |
|
vcard_id |
integer(int32)
|
ID of the vCard to be displayed |
|
alert_on |
boolean
|
Enable reading alerts |
|
email_cible |
array of (string)
|
Other notification email (only for Marketing projects) |
|
theme |
|
Theme (logo/colors) to be used for this project |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Theme (logo/colors) to be used for this project
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
theme id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project id |
|
name |
string
|
Project name |
|
consultable |
boolean
|
TRUE if the project if consultable |
|
verdict |
string
|
Verdict of the project (won/lost/na) |
|
is_template |
boolean
|
TRUE if this project will be used as a template |
|
can_be_downloaded |
boolean
|
TRUE if the documents can be downloaded |
|
preview_new |
string
|
|
|
duration |
string
|
Used only for templates, you can create projects from this template that will expire xx days later. |
|
starred |
boolean
|
TRUE if is a starred project |
|
external_id |
string
|
Project external_id |
|
url |
string
|
Project authentication url |
|
signed |
boolean
|
Project signed? |
|
signable |
boolean
|
Project signable? |
|
tags |
array of (string)
|
Project tags |
|
vcard_id |
integer(int32)
|
Project vcard_id |
|
email_cible |
array of (string)
|
Project email_cible |
|
alert_on |
boolean
|
Project alert_on |
|
created_at |
string
|
|
|
updated_at |
string
|
|
|
consultable_until |
string
|
Allow consultation until this date |
|
last_sign_in_at |
string
|
|
|
first_access_at |
string
|
|
|
collaborators_count |
integer(int32)
|
|
|
convert_status |
|
Project convert_status |
|
nb_connections |
integer(int32)
|
|
|
total_time |
integer(int32)
|
|
|
theme |
|
Project theme |
|
tokens_count |
integer(int32)
|
|
|
project_items_count |
integer(int32)
|
|
|
nb_used_as_template |
integer(int32)
|
|
|
email_templates_count |
integer(int32)
|
|
Summary:
Description: Project convert_status
Properties:
|
Name |
Type |
Summary |
|
complete_base |
boolean
|
|
|
complete_full |
boolean
|
|
Summary:
Description: Project theme
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project theme id |
|
name |
string
|
Project theme name |