---
title: REST API - Import Task Capture Payload
slug: rm/rest-api-import-task-capture-payload
docTags: 
createdAt: 2026-06-09T13:38:46.631Z
---

```bash
api/v1/taskCapture/payloads?artifactId={artifactId}&processTypeId={processTypeId}
```

# Description

Triggers an asynchronous job that in turn creates a Digital Blueprint under the selected artifact, with the actions sent in the payload. The request will return the Job ID, that can be used to check the job status with [Get Information of Import Task Capture Payload Job Request](docId\:rxa4kcjuiv4XgvajNF5NL).

# URL Structure

```bash
[Blueprint_URI]/api/v1/taskCapture/payloads?artifactId={artifactId}&processTypeId={processTypeId}
```

- `artifactId`: The ID of the parent artifact where the payload will be imported.
- `processTypeId` (optional): The artifact type of the imported process. If this parameter is not specified, Blueprint selects a random process artifact type in the project where the payload will be imported.

# Supported Methods

- ****[POST](docId\:Hsi_LzXS8g_RX_ydUdZKg)****

# HTTP Status Codes

- 200: OK – a job to import the payload is successfully triggered.
- 400: Bad Request:
  o The artifactId or processTypeId query parameter is not valid (less than 1) (errorCode=174).
  o The payload object in the request body is missing or invalid (missing required properties) (errorCode=175).
- 401 Unauthorized – the Blueprint authorization token is missing, invalid or expired (in the Authorization request header).
- 404: Not Found:
  - The artifact specified by the artifactId request parameter is not found, deleted, or does not exist, or the user does not have the Read permission on the specified artifact (errorCode=176).
  - The artifact type specified by the processTypeId request parameters is not found in the project the specified parent artifact belongs to (errorCode=177).
- 403 Forbidden – the user does not have the Edit permission on the specified artifact (errorCode=125).
- 409: Conflict
  - The specified artifact type is found in the project the specified parent artifact belongs to, but the artifact type is not a process artifact type (errorCode=178).
  - The project the specified parent artifact belongs to does not have any process artifact types. This case can happen when the processTypeId request parameter is not specified (errorCode=179).
  - The artifact is created by the user performing the request, but never published (errorCode=182).

# Example

## JSON Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/taskCapture/payloads?artifactId=123&processTypeId=10
```

**Request Body**

Contains the payload object.

```swift
{  "Version": 1,  "Name": "Task Capture Payload 1",  "Description": "This is the first payload.",  "Activities": [    {      "UserActionDescription": "User Action 1",      "SystemResponseDescription": "System Response 1",      "Image": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAAeAEoDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3Vmn+1R/u487Gx+8PqvtUu64/55Rf9/D/APE0N/x9x/8AXN/5rUtAEW64/wCeUX/fw/8AxNG64/55Rf8Afw//ABNS0UARbrj/AJ5Rf9/D/wDE0brj/nlF/wB/D/8AE1LRQBFuuP8AnlF/38P/AMTRuuP+eUX/AH8P/wATUtFAFVmn+1R/u487Gx+8PqvtUu64/wCeUX/fw/8AxNDf8fcf/XN/5rUtAETf8fcf/XN/5rUtVWtoPtUY8mPBRiRsHqtS/Zbf/nhF/wB8CgCWiovstv8A88Iv++BR9lt/+eEX/fAoAloqL7Lb/wDPCL/vgUfZbf8A54Rf98CgCWiovstv/wA8Iv8AvgUfZbf/AJ4Rf98CgAb/AI+4/wDrm/8ANalqq1tB9qjHkx4KMSNg9VqX7Lb/APPCL/vgUAf/2Q==",      "Selector": "[\r\n  {\r\n    \"filename\": \"%ProgramFiles%\\\\Microsoft Office\\\\Root\\\\Office16\\\\EXCEL.EXE\",\r\n",      "AppName": "Excel",      "Action": "Action 1",      "ActionParameters": [        {          "Name": "Parameter 1",          "Value": "Some text"        },        {          "Name": "Parameter 2",          "Value": "987"        }      ],      "Timestamp": "2021-10-25T20:08:50.627209Z"    }  ] }
```

**Response Body**

In the case of the returned 200: OK HTTP status code, contains the ID of the triggered job.

```json
{  "JobId": 123}
```

In the case of the 400: Bad Request HTTP status code, contains the error message.

```json
{  "Message": "The payload object is missing.",  "ErrorCode": 170}
```