Unpublish a bulk action | Documentation

curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/bulk_actions/unpublish \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "entities": {
    "sys": {
      "type": "Array"
    },
    "items": [
      {
        "sys": {
          "id": "<entity_id>",
          "type": "Link",
          "linkType": "<Entry|Asset>"
        }
      }
    ]
  }
}'

{
  "sys": {
    "id": "<bulk_action_id>",
    "type": "BulkAction",
    "status": "<status>",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "7BslKh9TdKGOK41VmLDjFZ"
      }
    },
    "createdAt": "2025-05-03T12:36:50.000Z",
    "updatedAt": "2025-05-03T12:36:50.000Z",
    "space": {
      "sys": {
        "type": "Link",
        "id": "yadj1kx9rmg0"
      }
    },
    "environment": {
      "sys": {
        "type": "Link",
        "id": "staging"
      }
    }
  },
  "action": "<action>",
  "payload": {
    "entities": {
      "sys": {
        "type": "Array"
      },
      "items": [
        {
          "sys": {
            "id": "<entity_id>",
            "type": "Link",
            "linkType": "<Entry|Asset>"
          }
        }
      ]
    }
  },
  "error": {
    "sys": {
      "id": "<error_type>",
      "type": "Error"
    }
  }
}

Unpublishes all content linked in the payload. Requires unpublish permissions on each item; limited by the number of active bulk actions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space as a string

environment_idstringRequired

ID of the environment as a string, falls back to master if not specified.

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful