Grouped Approvals

Create grouped approval

Creates a grouped approval: a set of document versions that move together through one or more approval paths, each an ordered sequence of stages with its own participants. Optionally associate it with a Workfront parent object via parentId/objCode, or seed it from a templateId.

post/api/v1/grouped-approvals

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/grouped-approvals
  • Auth: HTTP bearer

Headers

x-api-keystring required

client_id of the Adobe Developer Console technical account. Identifies the calling integration to the AIO gateway.

x-gw-subdomainstring required

Workfront customer subdomain (e.g. mycompany). Must match the subdomain of the Workfront instance being accessed. Passing an incorrect or unrecognized subdomain will result in a 502 Bad Gateway response from the AIO gateway.

wf-customeridstring required

Workfront customer ID.

wf-useridstring required

Workfront user ID of the acting user.

wf-lane'prod' | 'preview' | 'hub' | 'staging' | 'devtest' required

Workfront deployment lane.

x-request-idstring uuid

Unique identifier for request tracing. Auto-generated if not provided.

x-correlation-idstring

Unique identifier for correlation across multiple service calls. Auto-generated if not provided.

Request body

namestring required

Display name of the grouped approval.

parentIdstring

Workfront parent object ID to associate with this grouped approval. Requires objCode.

objCodestring

Workfront parent object type code (e.g. PROJ, TASK). Required when parentId is set.

templateIdstring

Optional approval-template ID to seed the workflow from.

assetsstring[] required

Document version (DOCV) IDs to include in the group.

Response

Created

groupedApprovalGuidstring

GUID of the created grouped approval.

imsOrgIdstring
customerIdstring
templateIdstring nullable
namestring
statusstring
decisionDatestring date-time nullable
assetReferenceTypesstring[]
createdByClientIdstring
lastModifiedByClientIdstring
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "groupedApprovalGuid": "9f8b60820000462ecf66c409d1248fa9",
  "imsOrgId": "1269195F66C8C84F0A494025@AdobeOrg",
  "customerId": "697be14f00392452aa729f7eb29059fe",
  "name": "Q1 Campaign Assets",
  "status": "not started",
  "decisionCounts": {
    "decided": 1,
    "undecided": 2
  },
  "creator": {
    "identityGuid": "698b60820000462ecf66c409d1248fa9",
    "type": "USER",
    "role": "approver",
    "status": "not started",
    "decisionCounts": {
      "decided": 1,
      "undecided": 2
    },
    "references": [
      {
        "id": "698b60820000462ecf66c409d1248fa9",
        "type": "wfUserId"
      },
      {
        "id": "1BF9194166C9284F0A49412F@13cc192466c8c9a949410f.e",
        "type": "imsUserId"
      },
      {
        "id": "approver@example.com",
        "type": "email"
      }
    ]
  },
  "realCreator": {
    "identityGuid": "698b60820000462ecf66c409d1248fa9",
    "type": "USER",
    "role": "approver",
    "status": "not started",
    "decisionCounts": {
      "decided": 1,
      "undecided": 2
    },
    "references": [
      {
        "id": "698b60820000462ecf66c409d1248fa9",
        "type": "wfUserId"
      },
      {
        "id": "1BF9194166C9284F0A49412F@13cc192466c8c9a949410f.e",
        "type": "imsUserId"
      },
      {
        "id": "approver@example.com",
        "type": "email"
      }
    ]
  },
  "assets": [
    {
      "assetGuid": "673fc29b0006af515e33732d1ebdc39a",
      "references": [
        {
          "id": "698b61d400011579a3dbc96cfb99ca06",
          "type": "DOCV"
        },
        {
          "id": "urn:aaid:sc:US:f9228e94-dace-34c9-91da-332a190186d4:0",
          "type": "esm"
        },
        {
          "id": "urn:aaid:aem:eb19fb9d-1543-47c1-b219-578f5be98d2c:1",
          "type": "genStudioDraft"
        }
      ],
      "decision": "approved"
    }
  ],
  "assetReferenceTypes": [
    "DOCV",
    "esm",
    "genStudioDraft"
  ],
  "paths": [
    {
      "pathId": "primary",
      "name": "Primary Review Path",
      "status": "not started",
      "decisionCounts": {
        "decided": 1,
        "undecided": 2
      },
      "stages": [
        {
          "stageId": "legal-review",
          "name": "Legal Review",
          "parentIds": [],
          "status": "not started",
          "decisionCounts": {
            "decided": 1,
            "undecided": 2
          },
          "deadlineDate": "2025-01-16T12:00:00.000Z",
          "participants": [
            {
              "identityGuid": "698b60820000462ecf66c409d1248fa9",
              "type": "USER",
              "role": "approver",
              "status": "not started",
              "decisionCounts": {
                "decided": 1,
                "undecided": 2
              },
              "references": [
                {
                  "id": "698b60820000462ecf66c409d1248fa9",
                  "type": "wfUserId"
                },
                {
                  "id": "1BF9194166C9284F0A49412F@13cc192466c8c9a949410f.e",
                  "type": "imsUserId"
                },
                {
                  "id": "approver@example.com",
                  "type": "email"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "createdByClientId": "workfront-fusion",
  "lastModifiedByClientId": "workfront-fusion",
  "createdAt": "2025-01-10T09:00:00.000Z",
  "updatedAt": "2025-01-10T09:00:00.000Z"
}

Changes