When creating a source or destination in Kondado, you can choose to invite a temporary user to perform this creation securely. This user will not have access to your account and will only be able to create the specific source or destination. See here how to do this through the graphical interface.

When using our API for this process, you can build a seamless flow in which your user does not need to share passwords with your team. After creating a source or destination, you will also be able to create new Pipelines.

Create a New Invitation

Description

Creates an invitation and returns an access link.

Method

POST

Endpoint

/collection_guests

URL Parameters

client_id

• Description: Parameter that indicates the account ID where the source or destination will be created. It can be obtained at app.kondado.com.br/account (it will appear next to your team name, in the format XXXXX-Y, where XXXXX is your client ID).
• Required: yes
• Format: integer number

recipient_email

• Description: Parameter that indicates the email address of the user who will receive the invitation. You may use a default email address if you do not want the user to receive an email invitation (the link will be exposed in the response).
• Required: yes
• Format: text

parent_collection_id

• Description: Parameter that indicates the ID of the parent collection (source/destination) to be used – see here how to list and retrieve parent collections.
• Required: yes
• Format: integer number

parent_collection_direction

• Description: Parameter that indicates whether the parent collection refers to:
  • src: a source
  • dest: a destination
• Required: yes
• Format: fixed values src or dest

assigned_collection_name

• Description: Parameter that indicates the name that will be assigned to the source or destination.
• Required: yes
• Format: text

Example Request (body)

{
    "client_id": "123456789",
    "recipient_email": "julia-pizzol@kondado.ai",
    "parent_collection_id": 130,
    "parent_collection_direction": "src",
    "assigned_collection_name": "[Guest] Toggl"
}

Example Response (body)

{
    "success": true,
    "data": {
        "success": true,
        "data": {
            "link": "https://app.kondado.com.br/collection_guest/eyJnasukaskxaskxbaskdbaskbdaksjcnkjqwkudhauwkdnasjklxn"
        }
    }
}

Response Description

The data object will return a link parameter containing the URL that can be accessed to create the source or destination according to the request.