Wrike

wrike

Wrike is a project management and collaboration tool offering customizable workflows, Gantt charts, reporting, and resource management to boost team productivity

Project Management Team Collaboration Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (38)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Bulk modify group membersWRIKE_BULK_MODIFY_GROUPSAcción

Adds or removes members for multiple wrike groups in a single request; all specified user ids must correspond to existing wrike users.

Parámetros de entrada

membersobject[]Obligatorio
List of group modification objects (max 20), each specifying a Wrike group and the members to add or remove.

Parámetros de salida

dataobjectObligatorio
Dictionary with response data. Structure varies by success/failure of individual operations.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a folderWRIKE_CREATE_FOLDERAcción

Creates a new wrike subfolder within the specified `folderid`, optionally as a project if `customitemtypeid` is given; the folder is auto-shared with its creator.

Parámetros de entrada

titlestringObligatorio
The title for the new folder.
fieldsstring[]
An optional list of field names to include in the response model, allowing for specific details about the created folder to be retrieved. Example fields include 'briefDescription', 'customFields', 'metadata', etc.
sharedsstring[]
A list of user IDs or invited user emails to share the folder with.
folderIdstringObligatorio
The unique identifier of the parent folder where the new subfolder will be created.
metadataobject[]
A list of metadata entries (key-value pairs) to associate with the newly created folder.
descriptionstring
An optional description for the new folder.
customFieldsobject[]
A list of custom field entries (ID and value) to set for the new folder.
customColumnsstring[]
A list of custom field IDs to be associated with the folder as columns. These typically control the visibility and order of custom fields in a table view.
userAccessRolesobject
A dictionary mapping user IDs to their access roles for this folder (e.g., 'Editor', 'Limited', 'Full', 'Owner'). The key is the user ID and the value is the access role name.
withInvitationsboolean
A boolean flag indicating whether to include invited (pending) users in the 'ownerIds' and 'sharedIds' lists in the response.
customItemTypeIdstring
The ID of a Custom Item Type. If provided, the created folder will be a project based on this type.
plainTextCustomFieldsboolean
A boolean flag. If true, HTML tags will be stripped from custom field values.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a groupWRIKE_CREATE_GROUPAcción

Creates a new user group in wrike with a specified title, optionally setting members, parent group, avatar, and custom metadata.

Parámetros de entrada

titlestringObligatorio
The title or name of the new group.
parentstring
The contact ID of an existing group to set as the parent for this new group. If omitted, the group will be a top-level group.
membersstring[]
List of Wrike user contact IDs to add as group members.
metadataobject[]
List of key-value metadata entries to associate with the group.
avatar__colorstring
The hex color code for the group's avatar background (e.g., '#FF0000' for red).
avatar__lettersstring
Up to two characters to display as the group's avatar. For example, 'MT' for 'Marketing Team'.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the details of the newly created group.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create invitationWRIKE_CREATE_INVITATIONAcción

Invites a user to a wrike workspace by email, optionally with name, specifying either `usertypeid` or a combination of `role`/`external`; custom email subject/message available for paid accounts.

Parámetros de entrada

rolestring
Role for the invited user (e.g., 'Admin', 'Regular User', 'External User'). Cannot be used if `userTypeId` is specified. Can be combined with `external`.
emailstringObligatorio
Email address of the user to invite.
messagestring
Custom message body for the invitation email (paid Wrike accounts only).
subjectstring
Custom subject for the invitation email (paid Wrike accounts only).
externalboolean
Flags invited user as external. Cannot be used if `userTypeId` is specified. Can be combined with `role`.
lastNamestring
Last name of the invited user.
firstNamestring
First name of the invited user.
userTypeIdstring
ID of the user type to assign (e.g., Admin, Regular User, External User). Cannot be used if `role` or `external` is specified.

Parámetros de salida

dataobjectObligatorio
Details of the created invitation, typically including the invitation ID and the email of the invitee.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create task in folderWRIKE_CREATE_TASKAcción

Creates a new task in a specified wrike folder; if setting priority with `prioritybefore` or `priorityafter`, the referenced task must be in the same folder or project.

Parámetros de entrada

titlestringObligatorio
Title of the task.
fieldsstring[]
JSON string array specifying optional fields to include in the task details of the response.
followboolean
If `True`, the creator automatically follows the task.
statusstringenum
Status of the task. Note: This feature may not be available on the Team plan.
ActiveCancelledCompletedDeferred
parentsstring[]
List of parent folder IDs for the task. Cannot include the recycleBinId.
sharedsstring[]
List of user or invitation IDs to share the task with; creator is auto-shared.
folderIdstringObligatorio
Unique identifier of the folder where the task will be created.
metadataobject[]
List of key-value metadata pairs for the task. Each item requires 'key' and 'value'.
followersstring[]
List of user IDs to be added as task followers.
importancestringenum
Importance level of the task.
HighLowNormal
superTasksstring[]
List of task IDs to which this new task will be a subtask.
billingTypestringenum
Billing type for the task's timelogs.
BillableNonBillableNonBillableAddToProjectReports
descriptionstring
Detailed description of the task.
customFieldsobject[]
List of custom fields for the task. Each item requires `id` (custom field ID) and `value`. Refer to Wrike API documentation for value formatting based on type.
customStatusstring
Unique ID of a custom status for the task.
responsiblesstring[]
List of user or invitation IDs to be assigned as responsible for the task.
priorityAfterstring
ID of an existing task to place the new task after in the list.
priorityBeforestring
ID of an existing task to place the new task before in the list.
withInvitationsboolean
If `True`, include invited (unregistered) users in response's `shareds` and `responsibles`.
customItemTypeIdstring
Unique ID of a Custom Item Type to use as a template for the task; task inherits its properties.
plainTextCustomFieldsboolean
If `True`, HTML tags will be stripped from custom field values before saving.
responsiblePlaceholdersstring[]
List of placeholder IDs (Job Roles) to be assigned as responsible for the task.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the data of the created task. The structure of this dictionary depends on the fields requested and the task details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete custom field by idWRIKE_DELETE_CUSTOM_FIELDAcción

Permanently deletes a custom field by its id; this action is irreversible and requires a valid, existing custom field id.

Parámetros de entrada

customFieldIdstringObligatorio
The unique identifier of the custom field to be permanently deleted.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the response data from the delete operation, typically confirming success.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete folderWRIKE_DELETE_FOLDERAcción

Permanently deletes the folder specified by `folderid` and all its contents (e.g., tasks, documents, subfolders) from the wrike workspace; this irreversible action is for when the folder is no longer needed and has no active tasks or dependencies that would block deletion.

Parámetros de entrada

folderIdstringObligatorio
The unique identifier of the folder to be deleted.

Parámetros de salida

dataobjectObligatorio
A dictionary containing data related to the outcome of the delete operation. This might include a confirmation or details of the deleted folder, though the specific structure can vary.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete group by idWRIKE_DELETE_GROUPAcción

Permanently deletes a group by its `groupid`; this action is irreversible and does not affect user accounts that were members of the group.

Parámetros de entrada

groupIdstringObligatorio
The unique identifier of the group to be deleted.

Parámetros de salida

dataobjectObligatorio
Confirmation from the delete operation; typically an empty or minimal body upon successful deletion (e.g., 204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete invitationWRIKE_DELETE_INIVTATIONAcción

Permanently deletes an existing invitation, specified by its unique `invitationid`; this action cannot be undone.

Parámetros de entrada

invitationIdstringObligatorio
The unique identifier of the invitation to be deleted. This ID can be obtained when an invitation is created or by listing existing invitations.

Parámetros de salida

dataobjectObligatorio
The response typically returns an empty body upon successful deletion, but this field is included for consistency with other API responses. It may contain a success message or be an empty dictionary.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete taskWRIKE_DELETE_TASKAcción

Permanently deletes a wrike task and all its associated data by its id; this action is irreversible and the task must exist.

Parámetros de entrada

taskIdstringObligatorio
The unique identifier of the task to be deleted.

Parámetros de salida

dataobjectObligatorio
A dictionary that may contain information regarding the status of the deletion operation. The exact structure can vary.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch all tasksWRIKE_FETCH_ALL_TASKSAcción

Fetches tasks from a wrike account, allowing filtering by status, due date, and subfolder inclusion, with customizable response fields and pagination.

Parámetros de entrada

fieldsstring[]
A list of field names to include for each task in the response. Author-related fields: 'responsibleIds' (assigned users), 'sharedIds' (users task is shared with), 'authorIds' (task creators), 'followerIds' (task followers). Other common fields: 'description', 'briefDescription', 'parentIds', 'superParentIds'. Custom fields can also be requested by their ID. If omitted, a default set of fields is returned. To include metadata in the response, add 'metadata' to this list.
statusstring
Filter tasks by their status. Only tasks matching the specified status will be returned (e.g., Active, Completed).
dueDateobject
Filter tasks by due date. Use 'equal' for an exact date match (yyyy-MM-dd), or 'start' and/or 'end' to define a date range (yyyy-MM-dd). If 'equal' is provided, 'start' and 'end' are ignored.
metadataobject
Filter tasks by metadata key-value pairs. Provide a dict of key-value pairs, e.g. {"department": "marketing", "region": "us"}. All pairs must match (AND logic).
page_sizeinteger
The number of tasks to return per page.
descendantsboolean
If true, tasks from all subfolders and subprojects are included. If false, only tasks from the specified folder/project are returned.
resolve_user_namesboolean
If true, automatically adds all user-related fields (authorIds, responsibleIds, sharedIds, followerIds) to the request and resolves user IDs to include user names and details directly in each task.

Parámetros de salida

dataobject[]Obligatorio
A list of task objects, where each object contains the details for a task according to the requested fields.
kindstringObligatorio
Identifies the type of data in the response, typically 'tasks'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get account informationWRIKE_GET_ACCOUNT_INFORMATIONAcción

Retrieves detailed wrike account information, where the response content is influenced by selected fields, account subscription, and user permissions.

Parámetros de entrada

fieldsstring[]
Specifies field names to include in the response; if omitted, a default set of fields is returned.

Parámetros de salida

dataobjectObligatorio
Account data; its structure and included fields vary based on the 'fields' request parameter and account subscription level.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all custom fieldsWRIKE_GET_ALL_CUSTOM_FIELDSAcción

Retrieves all custom field definitions (including id, name, type, and settings) from the wrike account; this returns the definitions themselves, not their specific values on wrike items, and is useful for obtaining custom field ids.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The raw JSON response from the Wrike API. This dictionary typically includes a 'kind' key (e.g., 'customfields') and a 'data' key, where the 'data' key contains a list of custom field objects, each detailing a custom field's ID, title, type (e.g., Text, Dropdown, Numeric), and settings.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get contactsWRIKE_GET_CONTACTSAcción

Retrieves a list of wrike contacts (e.g., team members, clients, collaborators); response includes contact details but not their detailed task or project involvement.

Parámetros de entrada

fieldsstring[]
List of contact fields to include (e.g., 'firstName', 'email'); defaults to a standard set if omitted.
deletedboolean
Filter by deletion status: `true` for deleted, `false` or omitted (default) for active contacts.
metadataobject
Filter by a dictionary of metadata key-value pairs; returns contacts matching all specified pairs.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get foldersWRIKE_GET_FOLDERSAcción

Retrieves folders and/or projects from wrike, with filters; when using `nextpagetoken`, all other filter parameters must match the initial request.

Parámetros de entrada

fieldsstring[]
List of optional fields to include in the response for each folder (Folders mode only).
deletedboolean
True to retrieve folders from the Recycle Bin; false or omitted to retrieve from Root.
projectboolean
Filter by entity type: true for projects, false for folders. If omitted, both are returned.
metadataobject
Filter folders based on their metadata. Provide a dictionary of metadata field names and their expected values.
pageSizeinteger
Maximum number of folders per page (1-1000). Only "folders" kind is supported for pagination.
permalinkstring
Folder permalink for an exact match.
descendantsboolean
Include all descendant folders in the search scope; false to search only within the specified folder(s).
updatedDateobject
Filter folders by their last updated date. Provide a dictionary with 'start', 'end', or 'equal' keys. Date format: yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ssXXX.
customFieldsobject[]
Filter folders by custom field values. Provide a list of filters, each specifying the custom field ID and value, or ID, comparator, and value. Example: `[{"id": "IEAGAAAAKZ7A____", "value": "Value"}]`.
contractTypesstring[]
Filter folders by a list of contract type IDs.
nextPageTokenstring
Pagination token from a previous response to retrieve the next page. All other filter parameters must match the initial request.
customItemTypesstring[]
Filter by a list of custom item type IDs. Standard types like 'project' or 'folder' IDs are not allowed.
withInvitationsboolean
Include invitations in the 'sharedIds' list of the response.
plainTextCustomFieldsboolean
True to strip HTML tags from custom field values in the response.

Parámetros de salida

dataobjectObligatorio
API response data, typically including a list of folders and pagination information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get specific contact informationWRIKE_GET_INFORMATION_ABOUT_SPECIFIC_CONTACTAcción

Retrieves detailed information for a specific wrike contact using their unique `contactid`, optionally including `metadata` and `customfields` if specified in the `fields` parameter.

Parámetros de entrada

fieldsstring[]
Optional list of specific fields (e.g., `metadata`, `customFields`) to include; returns default fields if omitted.
contactIdstringObligatorio
The unique identifier of the contact to retrieve information for.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the information for the specified contact. The structure of this dictionary depends on the fields requested.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get specific userWRIKE_GET_SPECIFIC_USERAcción

Retrieves detailed information about a specific user in wrike using their unique user id.

Parámetros de entrada

userIdstringObligatorio
The unique identifier of the user whose details are to be retrieved.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the detailed information of the specified user.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get task by idWRIKE_GET_TASK_BY_IDAcción

Retrieves read-only detailed information for a specific wrike task by its unique id, optionally allowing specification of fields to include in the response.

Parámetros de entrada

fieldsstring
A comma-separated list of optional fields to include in the response (e.g., 'recurrence,customFields,attachmentCount'). If not provided, a default set of fields will be returned.
taskIdstringObligatorio
The unique identifier of the task to retrieve.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the detailed information of the requested task.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Launch folder blueprint asyncWRIKE_LAUNCH_FOLDER_BLUEPRINT_ASYNCAcción

Asynchronously launches a new project or folder structure in wrike from a specified folder blueprint, typically returning a task id to track progress.

Parámetros de entrada

titlestringObligatorio
The title for the new root folder created from the blueprint.
parentstringObligatorio
The unique identifier of the parent folder where the blueprint structure will be created.
entry_limitinteger
The maximum number of tasks and folders that can be created from the blueprint. This limit must be between 1 and 250, inclusive. If the blueprint contains more items, the operation may fail or be partially completed.
title_prefixstring
A prefix to be added to the titles of all tasks and folders copied from the blueprint. If not provided, original titles are used.
reschedule_datestring
The new start date for all rescheduled tasks in the format YYYY-MM-DD. If provided, tasks will be rescheduled based on this date and the reschedule_mode.
reschedule_modestring
Defines how tasks are rescheduled. Common modes might include shifting tasks relative to the reschedule_date or anchoring them. Consult Wrike API documentation for specific values. Examples: 'Preserve', 'Shift'.
copy_attachmentsboolean
If true, attachments from the blueprint will be copied. Defaults to true if not specified.
copy_descriptionsboolean
Specifies whether to copy descriptions from the blueprint's tasks and folders. If true, descriptions are copied; otherwise, they are left empty. Defaults to true if not specified.
copy_responsiblesboolean
If true, responsible assignments from the blueprint will be copied to the new tasks. Defaults to true if not specified.
copy_custom_fieldsboolean
If true, custom field values from the blueprint will be copied to the new tasks and folders. Defaults to true if not specified.
folder_blueprint_idstringObligatorio
The unique identifier of the folder blueprint to be launched.
notify_responsiblesboolean
If true, users assigned as responsibles for tasks in the blueprint will be notified. Defaults to true if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Launch Task Blueprint AsyncWRIKE_LAUNCH_TASK_BLUEPRINT_ASYNCAcción

Asynchronously launches a wrike task blueprint to create tasks/projects, requiring either `super task id` (parent task) or `parent id` (parent folder/project) for placement.

Parámetros de entrada

titlestringObligatorio
Title for the root task created from the blueprint.
parent_idstring
ID of an existing parent folder/project for the new task(s); either this or `super_task_id` is required.
entry_limitinteger
Maximum number of tasks/folders to copy from blueprint (1-250).
title_prefixstring
Prefix for titles of all tasks created from this blueprint.
super_task_idstring
ID of an existing parent task for the new task(s); either this or `parent_id` is required.
reschedule_datestring
Target date (yyyy-MM-dd) for rescheduling tasks; requires `reschedule_mode`.
reschedule_modestring
How tasks are rescheduled if `reschedule_date` is set; valid values: `RescheduleStartDate`, `RescheduleFinishDate`.
copy_attachmentsboolean
Copy attachments from blueprint tasks to new tasks.
copy_descriptionsboolean
Copy blueprint task descriptions to new tasks; if false or omitted, new tasks will have empty descriptions.
copy_responsiblesboolean
Assign users responsible for blueprint tasks to the newly created tasks.
task_blueprint_idstringObligatorio
Unique identifier of the task blueprint to launch.
copy_custom_fieldsboolean
Copy custom field values from blueprint tasks to new tasks.
notify_responsiblesboolean
Notify users responsible for blueprint tasks when new tasks are created.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Folder BlueprintsWRIKE_LIST_FOLDER_BLUEPRINTSAcción

Retrieves all account-level folder blueprints, which are templates for standardizing folder/project creation with predefined structures, custom fields, and workflows.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List space folder blueprintsWRIKE_LIST_SPACE_FOLDER_BLUEPRINTSAcción

Lists all folder blueprints (templates for new folders/projects) within a specified wrike space, requiring a valid and accessible space id.

Parámetros de entrada

space_idstringObligatorio
The unique identifier of the Wrike space from which to list folder blueprints.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List space task blueprintsWRIKE_LIST_SPACE_TASK_BLUEPRINTSAcción

Lists task blueprints (templates for creating tasks with consistent structures) available in a specific, accessible wrike space.

Parámetros de entrada

limitinteger
Maximum total number of task blueprints to return.
space_idstringObligatorio
Unique identifier of the Wrike space from which to list task blueprints.
page_sizeinteger
Number of task blueprints to return per page for pagination.
next_page_tokenstring
Token from the previous page's response to retrieve the next page of results; if empty or omitted, fetches the first page.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List subfolders by folder idWRIKE_LIST_SUBFOLDERS_BY_FOLDER_IDAcción

Lists subfolders (metadata only, not their contents) for an existing wrike folder specified by `folderid`, supporting recursive descent, filtering, and pagination.

Parámetros de entrada

fieldsstring[]
Optional fields to include in the response for each folder (e.g., 'metadata', 'customFields').
projectboolean
Set true for projects only, false for regular folders only; omit for both or API default.
folderIdstringObligatorio
ID of the parent folder.
metadataobject
Filters folders by metadata using a dictionary of key-value pairs for exact match.
pageSizeinteger
Maximum folders per page (API default e.g., 100, max 1000).
permalinkstring
Permalink for an exact match search of the folder to fetch subfolders from.
descendantsboolean
Set to true to include all descendant subfolders; false for direct children only.
updatedDateobject
Filters folders by last updated date using comparators (e.g., 'LessThan', 'EqualTo') or a date range ('start', 'end' keys). Dates: 'yyyy-MM-dd' or 'yyyy-MM-ddTHH:mm:ssZ'.
customFieldsobject[]
Filters folders by custom field values using a list of filter objects (e.g., `{'id': 'customFieldId', 'comparator': 'EqualTo', 'value': 'FieldValue'}`). Refer to Wrike API documentation for detailed structure.
contractTypesstring[]
Filters projects by contract type names; mainly used when `project` is true.
nextPageTokenstring
Token from a previous response's `nextPageToken` field for pagination; other filters should match the initial request.
customItemTypesstring[]
Filters by a list of custom item type IDs (standard types like 'Project' or 'Folder' are not applicable).
withInvitationsboolean
If true, includes invited (but not yet accepted) users in `sharedIds` of returned folders.
plainTextCustomFieldsboolean
If true, strips HTML tags from custom field values in the response.

Parámetros de salida

dataobjectObligatorio
Complete JSON response from Wrike API, typically including `kind`, `data` (list of folder objects), and potentially `nextPageToken`.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Task BlueprintsWRIKE_LIST_TASK_BLUEPRINTSAcción

Retrieves a list of defined task blueprints (predefined task templates) from the wrike account, supporting pagination.

Parámetros de entrada

limitinteger
The maximum number of Task Blueprints to be returned in the API response. The Wrike API enforces a maximum value of 1000 for this parameter. Default is 1000.
page_sizeinteger
The number of Task Blueprints to include per page when paginating results. This parameter works in conjunction with `next_page_token`. Default is 100.
next_page_tokenstring
An opaque token for fetching the next page of Task Blueprints. This token is obtained from the `nextPageToken` field in a previous API response. If omitted or empty, the first page is retrieved. Providing this token might cause the API to ignore other filter parameters.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update account metadataWRIKE_MODIFY_ACCOUNTAcción

Updates or adds custom key-value metadata to the wrike account, useful for integrations, storing app-specific data, or mapping external system identifiers.

Parámetros de entrada

metadataobject[]
A list of metadata key-value pairs to update or add to the account. Metadata entries are isolated on a per-client (application) basis. If an empty list is provided or the field is omitted, no metadata changes will occur.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the account, including the updated metadata. The specific structure of the returned account data may vary based on the Wrike API version and account type.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify folder attributesWRIKE_MODIFY_FOLDERAcción

Modifies an existing wrike folder: updates title, description, parents (not root/recycle bin), sharing, metadata, custom fields/columns; restores, converts to project, or manages access roles.

Parámetros de entrada

titlestring
The new title for the folder.
fieldsstring[]
A list of optional field names to be included in the response model. Example: `["parentIds", "sharedIds", "customFields"]`.
restoreboolean
Set to true to restore the folder if it is currently in the Recycled Bin.
folderIdstringObligatorio
Unique identifier of the folder to be modified.
metadataobject[]
List of metadata entries (key-value pairs) to update for the folder.
addParentsstring[]
Parent folder IDs to add. Must be from the same Wrike account and not be rootFolderId or recycleBinId.
addSharedsstring[]
A list of user IDs or invitation IDs with whom to share the folder.
descriptionstring
The new description for the folder.
customFieldsobject[]
Custom fields to update or delete. Each object needs an 'id' and 'value'; pass the ID with a null value to clear.
customColumnsstring[]
A list of custom field IDs to be displayed as columns for this folder in the Wrike interface.
removeParentsstring[]
Parent folder IDs to remove. Must be from the same Wrike account and not be rootFolderId or recycleBinId.
removeSharedsstring[]
A list of user IDs or invitation IDs from whom to unshare the folder.
addAccessRolesobject
User IDs mapped to Wrike access roles (e.g., 'Full', 'Editor', 'Limited', 'Read Only') to assign for this folder. Example: `{"KUAJ25LC": "Editor", "KUAJ25LD": "Full"}`.
withInvitationsboolean
Set to true to include pending invitations in the 'ownerIds' and 'sharedIds' lists within the response.
removeAccessRolesstring[]
A list of user IDs whose specific access roles for this folder should be revoked.
clearCustomColumnsboolean
Set to true to remove all custom field column associations from this folder.
plainTextCustomFieldsboolean
Set to true to strip any HTML tags from custom field values during the update operation, saving them as plain text.
convertToCustomItemTypestring
The ID of a Custom Item Type. If provided, the folder will be converted into a project of this specified custom item type.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify groupWRIKE_MODIFY_GROUPAcción

Updates an existing wrike user group's attributes like title, members, parent, avatar, or metadata, using its `groupid` and specifying only the fields to change.

Parámetros de entrada

titlestring
New title for the group.
parentstring
ID of an existing group to set as parent for hierarchical organization.
groupIdstringObligatorio
Unique ID of the group to modify.
metadataobject[]
Custom metadata key-value pairs to update. Existing keys are updated, new ones added. To remove, set value to '"null"'.
addMembersstring[]
Wrike User IDs to add to the group. Users must exist.
avatar__colorstring
New avatar background color (e.g., '#3AB795').
removeMembersstring[]
Wrike User IDs to remove from the group.
addInvitationsstring[]
User IDs of invited users (pending Wrike invitation) to add to the group.
avatar__lettersstring
New avatar letters for the group (max 2 chars, e.g., 'RD').
removeInvitationsstring[]
User IDs of invited users to remove from the group.

Parámetros de salida

dataobjectObligatorio
Data of the updated group, reflecting all properties post-modification.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify taskWRIKE_MODIFY_TASKAcción

Modifies an existing wrike task by its id, allowing updates to attributes such as title, status, dates, assignees, and custom fields; `prioritybefore` and `priorityafter` are mutually exclusive, and parent folder ids for `addparents`/`removeparents` cannot be the recycle bin.

Parámetros de entrada

datesobject
A dictionary specifying the task's date-related attributes. Allowed keys include `type` (e.g., 'Planned', 'Actual'), `duration` (in minutes), `start` (YYYY-MM-DD), `due` (YYYY-MM-DD), and `workOnWeekends` (boolean).
titlestring
The new title for the task.
fieldsstring[]
A list of optional field names to be included in the response object. Provide a list of strings, where each string is a valid field key. For example, `["recurrence", "responsibleIds"]`.
followboolean
Set to `true` to make the current API user follow the task, or `false` to unfollow.
statusstringenum
The new status of the task. This field is not available for accounts on the Team plan.
ActiveCompletedDeferredCancelled
taskIdstringObligatorio
The unique identifier of the task to be modified.
restoreboolean
Set to `true` to restore the task if it is currently in the Recycle Bin.
metadataobject[]
A list of metadata key-value pairs to update. Providing a `null` value for an existing key's `value` will remove that entry.
addParentsstring[]
A list of folder IDs to which the task will be added (i.e., moved into). Cannot include the Recycle Bin folder ID.
addSharedsstring[]
A list of user IDs or invitation IDs with whom the task will be shared.
importancestringenum
The new importance level of the task.
HighNormalLow
billingTypestringenum
Specifies the billing type for the task's timelogs.
NonBillableBillableNonBillableAddToProjectReports
descriptionstring
The new detailed description for the task. Supports HTML formatting.
addFollowersstring[]
A list of user IDs to be added as followers to the task. Followers receive notifications about task updates.
customFieldsobject[]
A list of custom field updates. Each object should specify the `id` of the custom field and its new `value`. To remove a custom field's value, set `value` to `null` (or an empty string for certain types). Example: `{"id": "customFieldId123", "value": "newValue"}`.
customStatusstring
The ID of the custom status to apply to the task. This is used when custom workflows are enabled in the Wrike account.
addSuperTasksstring[]
A list of task IDs that will become parent tasks to the current task, effectively making the current task a subtask of each specified task.
priorityAfterstring
The ID of an existing task after which the current task should be placed in the task list, determining its priority. Mutually exclusive with `priorityBefore`.
removeParentsstring[]
A list of folder IDs from which the task will be removed. Cannot include the Recycle Bin folder ID.
removeSharedsstring[]
A list of user IDs or invitation IDs from whom the task will be unshared.
priorityBeforestring
The ID of an existing task before which the current task should be placed in the task list, determining its priority. Mutually exclusive with `priorityAfter`.
addResponsiblesstring[]
A list of user IDs or invitation IDs to be added to the task's assignee list.
withInvitationsboolean
Set to `true` to include pending invitations in the `sharedIds` and `responsibleIds` fields within the response data. Default is `false`.
removeSuperTasksstring[]
A list of task IDs from which the current task will be removed as a subtask.
removeResponsiblesstring[]
A list of user IDs or invitation IDs to be removed from the task's assignee list.
plainTextCustomFieldsboolean
Set to `true` to strip HTML tags from custom field values before saving. If `false`, HTML content is preserved. API defaults to `false` behavior if not provided.
convertToCustomItemTypestring
The ID of a Custom Item Type to which this task should be converted. This changes the task's type and may alter its available custom fields and behavior.
addResponsiblePlaceholdersstring[]
A list of placeholder IDs to be added to the task's placeholder assignee list. Placeholders represent roles or groups.
removeResponsiblePlaceholdersstring[]
A list of placeholder IDs to be removed from the task's placeholder assignee list.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the updated task object, reflecting the changes made. The specific fields returned can be controlled using the `fields` parameter in the request.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve custom field by idWRIKE_QUERY_CUSTOMFIELDSAcción

Retrieves a wrike custom field's detailed information (e.g., type, possible values for dropdowns), properties, and metadata; the `customfieldid` must correspond to an existing custom field.

Parámetros de entrada

customFieldIdstringObligatorio
Unique identifier of the custom field.

Parámetros de salida

dataobjectObligatorio
Detailed information of the retrieved custom field, including its properties, configuration, and metadata.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query invitationsWRIKE_QUERY_INVITATIONSAcción

Retrieves all active invitations in wrike, useful for viewing and auditing pending invitations or managing user onboarding.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get group by idWRIKE_QUERY_SPECIFIC_GROUPAcción

Retrieves detailed information for a specific wrike group using its `groupid`, optionally including 'metadata'.

Parámetros de entrada

fieldsstring[]
Specifies a list of optional fields to be included in the response. The only valid value to pass in the list is 'metadata', which will include group metadata. If omitted or an empty list is provided, a default representation of the group is returned.
groupIdstringObligatorio
The unique identifier of the Wrike group whose details are to be retrieved.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the detailed information of the queried group. The structure and content of this dictionary depend on the group's attributes and the 'fields' parameter specified in the request (if any).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query workflowsWRIKE_QUERY_WORKFLOWSAcción

Fetches a list of all workflows with their detailed information from the wrike account; this is a read-only action and does not support pagination or filtering through its parameters.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve list of groupsWRIKE_RETRIEVE_LIST_OF_GROUPSAcción

Retrieves a list of user groups from the wrike account, supporting metadata filtering, pagination, and inclusion of specific fields; this is a read-only operation.

Parámetros de entrada

fieldsstring[]
Optional fields to include per group; only 'metadata' (custom key-value pairs) is currently supported. Default fields are returned if omitted.
metadataobject
Filters groups by exact match on custom metadata; keys are field IDs/names, values are expected metadata.
pageSizeinteger
Maximum group entries per page for pagination; API default applies if omitted.
pageTokenstring
Token from a previous response's 'nextPageToken' to get the next page; typically overrides other query parameters.

Parámetros de salida

dataobjectObligatorio
Complete JSON response body, typically including 'kind' (e.g., 'groups'), 'data' (list of group objects), and 'nextPageToken' for pagination.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update custom field by idWRIKE_UPDATE_CUSTOM_FIELD_BY_IDAcción

Updates properties of an existing wrike custom field by its id, such as its title, type, scope, or sharing settings.

Parámetros de entrada

typestring
New type for the custom field. Changing this can affect existing data.
titlestring
New title for the custom field.
sharingobject
Defines access settings, superseding `addShareds` and `removeShareds`. Expected format is an array of objects, e.g., `[{"accessorId": "ID", "accessType": "ReadOnly | ReadWrite"}]`.
spaceIdstring
ID of the Space. Required if `changeScope` is 'AccountToSpace' or when changing a space-level custom field's space association.
settingsobject
Settings specific to the custom field type, e.g., list values for 'DropDown', decimal places for 'Numeric'. Structure varies by 'type'.
addMirrorsstring[]
List of custom field IDs to add as mirrors. Applicable only to 'LinkToDatabase' custom fields.
addSharedsstring[]
Obsolete: Use the `sharing` parameter instead.
changeScopestring
Specifies if the custom field's scope should change. Use 'AccountToSpace' (requires `spaceId`) to convert an account-level field to space-level, or 'SpaceToAccount' to convert a space-level field to account-level.
customFieldIdstringObligatorio
Identifier of the custom field to be updated.
removeMirrorsstring[]
List of custom field IDs to remove as mirrors. Applicable only to 'LinkToDatabase' custom fields.
removeSharedsstring[]
Obsolete: Use the `sharing` parameter instead.

Parámetros de salida

dataobjectObligatorio
Details of the updated custom field.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update invitationWRIKE_UPDATE_INVITATIONAcción

Updates a pending wrike invitation (`invitationid`) to resend it or change user's role/type (use `usertypeid` over deprecated `role`/`external`).

Parámetros de entrada

rolestringenum
[DEPRECATED] User's role (e.g., 'User', 'Collaborator'); prefer 'userTypeId'. Mutually exclusive with 'userTypeId'.
CollaboratorUser
resendboolean
Resends the invitation email if true.
externalboolean
[DEPRECATED] Marks user as external; prefer 'userTypeId'. Requires 'role' to be 'User'. Mutually exclusive with 'userTypeId'.
userTypeIdstring
User type ID determining role/permissions. Recommended; mutually exclusive with 'role'/'external'.
invitationIdstringObligatorio
Unique identifier of the invitation to modify.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update metadata on a specific contactWRIKE_UPDATE_METADATA_ON_SPECIFIC_CONTACTAcción

Updates metadata, job role, or custom fields for an existing wrike contact specified by `contactid`; if `jobroleid` is provided, it must be a valid id.

Parámetros de entrada

fieldsstring[]
Optional list of field names to include in the response. If provided, only these fields will be returned.
metadataobject[]
List of metadata key-value pairs to update. Users typically have read/write access to their own metadata; other entries may be read-only.
contactIdstringObligatorio
Unique identifier of the contact to update.
jobRoleIdstring
Unique identifier of the job role to assign, which updates the contact's current role.
customFieldsobject[]
List of custom field updates. Each item should specify the custom field and its new value. Providing a null value might remove the custom field, depending on API behavior.

Parámetros de salida

dataobjectObligatorio
Data of the updated contact. Specific fields returned depend on the request, particularly the `fields` parameter.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a specific userWRIKE_UPDATE_SPECIFIC_USERAcción

Updates specified profile attributes (e.g., account id, role, external status) for an existing wrike user; unspecified fields remain unchanged.

Parámetros de entrada

userIdstringObligatorio
Unique identifier for the user whose profile is to be updated.
profile__rolestring
Role to assign to the user's profile.
profile__externalboolean
Indicates if the user is an external user.
profile__accountIdstring
Unique identifier of the account to associate with the user's profile.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not