# Bonjoro

> Manage video-message tasks and profiles, and read campaigns, templates, results and task activity.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/bonjoro

## Actions

### Complete task

Mark greet as complete.

**Inputs**

- Greet ID (`greet_id`, text, required): Greet id.
- Via (`via`, list): Via. One or more of: `email`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "assignee": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "attributes_url": "example",
      "created_at": "example",
      "draft": false,
      "event": {
        "id": "example",
        "message": "example",
        "occured_at": "example",
        "source": "example",
        "type": "example"
      },
      "events_url": "example",
      "id": "example",
      "link_id": "example",
      "message_template": {
        "created_at": "example",
        "creator": {
          "bio": "example",
          "first_name": "example",
          "id": "example",
          "image": "example",
          "last_name": "example",
          "name": "example",
          "self_url": "example",
          "team_url": "example"
        },
        "email_template": {
          "layout": "html",
          "message_template": "example",
          "subject_line": "example"
        },
        "id": "example",
        "is_greet_shareable": false,
        "landing_page": {
          "background": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          },
          "background_type": "Media",
          "cta": {
            "created_at": "example",
            "id": "example",
            "is_displayed": false,
            "text": "example",
            "updated_at": "example",
            "url": "example"
          },
          "logo": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          }
        },
        "name": "example",
        "state": "open",
        "stats": {
          "percentage_clicks": 1,
          "percentage_opens": 1,
          "percentage_reactions": 1,
          "percentage_replies": 1,
          "percentage_views": 1,
          "total": 1
        },
        "theme": {
          "created_at": "example",
          "id": "example",
          "primary_color": "example",
          "secondary_color": "example",
          "updated_at": "example"
        },
        "updated_at": "example"
      },
      "profiles": [],
      "record_url": "example",
      "self_url": "example",
      "status": "example",
      "thumb_url": "example",
      "updated_at": "example",
      "uploads_url": "example"
    },
    "message": "example"
  }
}
```

### Create profile

Add profile.

**Inputs**

- Email (`email`, text, required): Email.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes_url": "example",
      "created_at": "example",
      "demographic": {
        "age": "example",
        "country": "example",
        "location": "example",
        "sex": "example"
      },
      "email": "example",
      "events_url": "example",
      "first_name": "example",
      "id": "example",
      "image": "example",
      "last_name": "example",
      "name": "example",
      "self_url": "example",
      "unsubscribed": false,
      "updated_at": "example",
      "work": {
        "current": "example",
        "title": "example"
      }
    },
    "message": "example"
  }
}
```

### Create task

Add a greet.

**Inputs**

- Profiles (`profiles`, list, required): An array of profiles
- Assignee (`assignee_id`, text): The assignee of the created task
- Note (`note`, text): A note to add to the task
- Campaign (`campaign_id`, text): The workspace in which to create the task
- Template (`template_id`, text): A message template to set for the task
- Custom attributes (`custom_attributes`, object): Key/value pairs describing custom attributes for the task

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "assignee": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "attributes_url": "example",
      "created_at": "example",
      "draft": false,
      "event": {
        "id": "example",
        "message": "example",
        "occured_at": "example",
        "source": "example",
        "type": "example"
      },
      "events_url": "example",
      "id": "example",
      "link_id": "example",
      "message_template": {
        "created_at": "example",
        "creator": {
          "bio": "example",
          "first_name": "example",
          "id": "example",
          "image": "example",
          "last_name": "example",
          "name": "example",
          "self_url": "example",
          "team_url": "example"
        },
        "email_template": {
          "layout": "html",
          "message_template": "example",
          "subject_line": "example"
        },
        "id": "example",
        "is_greet_shareable": false,
        "landing_page": {
          "background": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          },
          "background_type": "Media",
          "cta": {
            "created_at": "example",
            "id": "example",
            "is_displayed": false,
            "text": "example",
            "updated_at": "example",
            "url": "example"
          },
          "logo": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          }
        },
        "name": "example",
        "state": "open",
        "stats": {
          "percentage_clicks": 1,
          "percentage_opens": 1,
          "percentage_reactions": 1,
          "percentage_replies": 1,
          "percentage_views": 1,
          "total": 1
        },
        "theme": {
          "created_at": "example",
          "id": "example",
          "primary_color": "example",
          "secondary_color": "example",
          "updated_at": "example"
        },
        "updated_at": "example"
      },
      "profiles": [],
      "record_url": "example",
      "self_url": "example",
      "status": "example",
      "thumb_url": "example",
      "updated_at": "example",
      "uploads_url": "example"
    },
    "message": "example"
  }
}
```

### Delete task

Delete a greet.

**Inputs**

- Greet ID (`greet_id`, text, required): Greet id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "assignee": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "attributes_url": "example",
      "created_at": "example",
      "draft": false,
      "event": {
        "id": "example",
        "message": "example",
        "occured_at": "example",
        "source": "example",
        "type": "example"
      },
      "events_url": "example",
      "id": "example",
      "link_id": "example",
      "message_template": {
        "created_at": "example",
        "creator": {
          "bio": "example",
          "first_name": "example",
          "id": "example",
          "image": "example",
          "last_name": "example",
          "name": "example",
          "self_url": "example",
          "team_url": "example"
        },
        "email_template": {
          "layout": "html",
          "message_template": "example",
          "subject_line": "example"
        },
        "id": "example",
        "is_greet_shareable": false,
        "landing_page": {
          "background": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          },
          "background_type": "Media",
          "cta": {
            "created_at": "example",
            "id": "example",
            "is_displayed": false,
            "text": "example",
            "updated_at": "example",
            "url": "example"
          },
          "logo": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          }
        },
        "name": "example",
        "state": "open",
        "stats": {
          "percentage_clicks": 1,
          "percentage_opens": 1,
          "percentage_reactions": 1,
          "percentage_replies": 1,
          "percentage_views": 1,
          "total": 1
        },
        "theme": {
          "created_at": "example",
          "id": "example",
          "primary_color": "example",
          "secondary_color": "example",
          "updated_at": "example"
        },
        "updated_at": "example"
      },
      "profiles": [],
      "record_url": "example",
      "self_url": "example",
      "status": "example",
      "thumb_url": "example",
      "updated_at": "example",
      "uploads_url": "example"
    },
    "message": "example"
  }
}
```

### Get automation

Update an automation.

**Inputs**

- Automation ID (`automation_id`, text, required): Automation id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "action": {
      "id": "example",
      "logo_url": false,
      "name": "example",
      "service_id": false,
      "short_name": false
    },
    "enabled": false,
    "id": "example",
    "is_setup": false,
    "name": "example",
    "trigger": {
      "id": "example",
      "logo_url": false,
      "name": "example",
      "service_id": false,
      "short_name": false
    }
  }
}
```

### Get campaign

Get a campaign.

**Inputs**

- Campaign (`campaign_id`, text, required): Campaign id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "archived_at": "example",
      "creator": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "goal": "example",
      "id": 1,
      "is_default": false,
      "is_private": false,
      "name": "example",
      "slug": "example",
      "type": "example",
      "uuid": "example"
    }
  }
}
```

### Get profile

Get profile.

**Inputs**

- Profile ID (`profile_id`, text, required): Profile id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "attributes_url": "example",
    "created_at": "example",
    "demographic": {
      "age": "example",
      "country": "example",
      "location": "example",
      "sex": "example"
    },
    "email": "example",
    "events_url": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "stats": {
      "clicked": false,
      "clicks": 1,
      "date_opened": "example",
      "date_replied": "example",
      "opened": false,
      "opens": 1,
      "reacted": false,
      "reactions": 1,
      "recipient_replied": false,
      "shared": false,
      "shares": 1,
      "viewed": false,
      "views": 1,
      "watched": false
    },
    "unsubscribed": false,
    "updated_at": "example",
    "work": {
      "current": "example",
      "title": "example"
    }
  }
}
```

### Get team

Get a team.

**Inputs**

- Team ID (`team_id_value`, text, required): Team id value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example",
    "invites_url": "example",
    "landing_page_host": "example",
    "landing_page_subdomain": "example",
    "links_url": "example",
    "name": "example",
    "owner_id": "example",
    "owner_url": "example",
    "self_url": "example"
  }
}
```

### Get template

Get message template.

**Inputs**

- Message template ID (`message_template_id`, text, required): Message template id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "created_at": "example",
      "creator": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "email_template": {
        "layout": "html",
        "message_template": "example",
        "subject_line": "example"
      },
      "id": "example",
      "is_greet_shareable": false,
      "landing_page": {
        "background": {
          "created_at": "example",
          "id": "example",
          "name": "example",
          "tags": "example",
          "type": "Media",
          "updated_at": "example",
          "url": "example"
        },
        "background_type": "Media",
        "cta": {
          "created_at": "example",
          "id": "example",
          "is_displayed": false,
          "text": "example",
          "updated_at": "example",
          "url": "example"
        },
        "logo": {
          "created_at": "example",
          "id": "example",
          "name": "example",
          "tags": "example",
          "type": "Media",
          "updated_at": "example",
          "url": "example"
        }
      },
      "name": "example",
      "state": "open",
      "stats": {
        "percentage_clicks": 1,
        "percentage_opens": 1,
        "percentage_reactions": 1,
        "percentage_replies": 1,
        "percentage_views": 1,
        "total": 1
      },
      "theme": {
        "created_at": "example",
        "id": "example",
        "primary_color": "example",
        "secondary_color": "example",
        "updated_at": "example"
      },
      "updated_at": "example"
    }
  }
}
```

### Get user

Get a user.

**Inputs**

- User ID (`user_id_value`, text, required): User id value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "bio": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "team_url": "example"
  }
}
```

### List attribute types

Get all profile attribute types.

**Inputs**: None.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List automations

Get paginated automations.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List campaigns

Get paginated campaigns.

**Inputs**

- Limit (`limit`, number): Limit.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List events

Get paginated events.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List profiles

Get paginated profiles.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "attributes_url": "example",
    "created_at": "example",
    "demographic": {
      "age": "example",
      "country": "example",
      "location": "example",
      "sex": "example"
    },
    "email": "example",
    "events_url": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "unsubscribed": false,
    "updated_at": "example",
    "work": {
      "current": "example",
      "title": "example"
    }
  }
}
```

### List replies

Get paginated replies.

**Inputs**

- Greet ID (`greet_id`, text, required): Greet id.
- Profile ID (`propfile_id`, text, required): Propfile id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List results

Get paginated greet results.

**Inputs**

- Sort (`sort`, text): Sort. One of: `created_at` (Created at), `updated_at` (Updated at), `uploaded_at` (Uploaded at), `awaiting_reply` (Awaiting reply), `last_modified` (Last modified), `last_replied_at` (Last replied at).
- Assignee (`assignee_id`, text): Assignee id.
- Profile ID (`profile_id`, text): Profile id.
- Limit (`limit`, number): Limit.
- Simple (`simple`, true/false): Simple.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List task events

Get paginated greet events.

**Inputs**

- Greet ID (`greet_id`, text, required): Greet id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List task profiles

Get paginated greet profiles.

**Inputs**

- Greet ID (`greet_id`, text, required): Greet id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List tasks

Get paginated greets.

**Inputs**

- Profile ID (`profile_id`, text): Profile id.
- Assignee (`assignee_id`, text): Assignee id.
- Status (`status`, text): Status. One of: `open`, `closed`, `sent`.
- Simple (`simple`, true/false): Simple.
- Search (`search`, text): Search for profiles where email, firstname and lastname matches the search term
- Sort (`sort`, text): Sort. One of: `created_at` (Created at), `updated_at` (Updated at), `uploaded_at` (Uploaded at), `awaiting_reply` (Awaiting reply), `last_modified` (Last modified), `last_replied_at` (Last replied at).

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List teams

Get paginated teams.

**Inputs**

- Includes (`includes`, text): Includes. One of: `signatures`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List templates

Get paginated message templates.

**Inputs**

- Limit (`limit`, number): Limit.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List todos

Get paginated greet todos.

**Inputs**

- Profile ID (`profile_id`, text): Profile id.
- Assignee (`assignee_id`, text): Assignee id.
- Search (`search`, text): Search for profiles where email, firstname and lastname matches the search term

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### List users

Get paginated users in the same team.

**Inputs**

- Includes (`includes`, text): Includes. One of: `signatures`.
- Limit (`limit`, number): Limit.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}
```

### Update profile

Update profile.

**Inputs**

- Profile ID (`profile_id`, text, required): Profile id.
- Email (`email`, text): Email.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "attributes_url": "example",
    "created_at": "example",
    "demographic": {
      "age": "example",
      "country": "example",
      "location": "example",
      "sex": "example"
    },
    "email": "example",
    "events_url": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "unsubscribed": false,
    "updated_at": "example",
    "work": {
      "current": "example",
      "title": "example"
    }
  }
}
```
