# Planly

All-in-one social media management tool for scheduling and managing content across multiple platforms

- **Category:** social media marketing
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `PLANLY`
- **Version:** 00000000_00

## Tools

### Complete AI Prompt

**Slug:** `PLANLY_COMPLETE_AI_PROMPT`

Tool to complete a text prompt using AI. Generates AI-powered text completions based on the provided prompt. Use when you need to generate creative content, complete text, or get AI suggestions for writing tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `n` | integer | Yes | How many results to generate. Specify the number of AI-powered text completions to return. |
| `prompt` | string | Yes | Prompt as a text to be completed by AI. Provide the text content you want AI to generate completions for. |
| `teamId` | string | Yes | Id of team to use for AI prompt completion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Team

**Slug:** `PLANLY_CREATE_TEAM`

Tool to create a new team in Planly. Use when you need to create a team organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the team to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Media

**Slug:** `PLANLY_DELETE_MEDIA`

Tool to delete one or more media files by their IDs. Use when you need to remove media files from Planly storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | Array of media IDs to delete. Each ID should be a UUID string representing a media file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Team

**Slug:** `PLANLY_DELETE_TEAM`

Tool to delete a team by its ID. Use when you need to permanently remove a team from Planly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | Unique identifier of the team to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Team

**Slug:** `PLANLY_EDIT_TEAM`

Tool to edit team details such as name in Planly. Use when you need to update an existing team's information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New name for the team |
| `teamId` | string | Yes | Team ID (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AI Credits

**Slug:** `PLANLY_GET_AI_CREDITS`

Tool to retrieve available AI credits left in a team. Use when you need to check the remaining AI credits for a specific team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teamId` | string | Yes | Id of team to retrieve AI credits for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Team

**Slug:** `PLANLY_GET_TEAM`

Tool to retrieve detailed information about a specific team including permissions, limits, and integrations. Use when you need to access team configuration, member counts, channel status, or integration details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Team ID to retrieve information for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Media From URL

**Slug:** `PLANLY_IMPORT_MEDIA_FROM_URL`

Tool to import media from a URL to your team. Use when you need to add external media (video/mp4, image/png, image/jpeg, image/webp) to a team's media library.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | URL of the media to import. Supported media content types are video/mp4, image/png, image/jpeg, image/webp. |
| `teamId` | string | Yes | ID of the team to import media to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channels

**Slug:** `PLANLY_LIST_CHANNELS`

Tool to list all social media channels connected to a team. Use when you need to retrieve channel details including name, picture, social network type, status, and scopes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team to retrieve its channels |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List media files

**Slug:** `PLANLY_LIST_MEDIA`

Tool to retrieve a paginated list of media files in a team. Use when you need to fetch media assets, browse uploaded files, or implement media management features with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team to retrieve media files for |
| `pagination` | object | No | Pagination configuration for listing media. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Schedule Groups

**Slug:** `PLANLY_LIST_SCHEDULE_GROUPS`

Tool to retrieve a list of schedule groups for a team with comprehensive filtering and pagination. Use when you need to view scheduled posts, filter by channels, status, social networks, media type, or date range. Returns detailed information about each schedule group including individual schedules and their status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Array of specific schedule group IDs to retrieve. Use when you need to fetch specific schedule groups by their IDs. |
| `filter` | object | No | Filter options for schedule groups. |
| `teamId` | string | Yes | ID of the team to retrieve schedule groups for. Required to scope the request to a specific team. |
| `dateRange` | object | No | Date range filter for schedule groups. |
| `pagination` | object | No | Pagination options for schedule groups listing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Schedules

**Slug:** `PLANLY_LIST_SCHEDULES`

Tool to retrieve a paginated list of schedules in a specified team. Use when you need to fetch schedules with support for pagination, custom ordering, and configurable page size. Returns schedule data with a cursor for fetching additional pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teamId` | string | Yes | ID of the team to retrieve its schedules |
| `pagination` | object | No | Pagination configuration for list schedules request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `PLANLY_LIST_TEAMS`

Tool to retrieve all teams that the authenticated user belongs to. Use when you need to get team details including id, name, picture, role, number of users, and number of channels.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Users

**Slug:** `PLANLY_LIST_TEAM_USERS`

Tool to list all users that belong to a specific team. Returns user details including id, fullname, picture, email, and role. Use when you need to retrieve the complete roster of team members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Team ID to list users for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Media Upload

**Slug:** `PLANLY_START_MEDIA_UPLOAD`

Tool to start the upload process for a media file. Returns a pre-signed upload URL where the file should be uploaded using a PUT request. Use when you need to prepare for uploading images or videos to Planly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teamId` | string | Yes | ID of the team to which the media will be uploaded |
| `fileName` | string | No | Name of the file being uploaded. Required if contentType is not provided |
| `contentType` | string | No | MIME type of the file (e.g., image/jpeg, video/mp4, image/png). Required if fileName is not provided |
| `contentLength` | integer | Yes | Size of the file in bytes |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |