Objects
Subscriptions
Bulk operations

Bulk add subscriptions

Changed on

Add subscriptions for all objects in a single collection. If a subscription for an object in the collection already exists, it will be updated. This endpoint also handles inline identifications for the recipient field.

post/v1/objects/{collection}/bulk/subscriptions/add

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/objects/{collection}/bulk/subscriptions/add
  • Auth: HTTP bearer

Path parameters

collectionstring required

The collection this object belongs to.

Request body

Example request

{
  "subscriptions": [
    {
      "id": "project-1",
      "properties": null,
      "recipients": [
        {
          "id": "user_1"
        }
      ]
    }
  ]
}

Response

OK

__typenamestring required

The typename of the schema.

completed_atstring date-time nullable

Timestamp when the bulk operation was completed.

error_countinteger

The number of failed operations.

estimated_total_rowsinteger required

The estimated total number of rows to process.

failed_atstring date-time nullable

Timestamp when the bulk operation failed.

idstring uuid required

Unique identifier for the bulk operation.

inserted_atstring date-time required

Timestamp when the resource was created.

namestring required

The name of the bulk operation.

processed_rowsinteger required

The number of rows processed so far.

progress_pathstring uri

The URI to the bulk operation's progress.

started_atstring date-time nullable

Timestamp when the bulk operation was started.

status'queued' | 'processing' | 'completed' | 'failed' required

The status of the bulk operation.

success_countinteger required

The number of successful operations.

updated_atstring date-time required

The timestamp when the resource was last updated.

Example response

{
  "__typename": "BulkOperation",
  "completed_at": null,
  "error_count": 0,
  "error_items": [],
  "estimated_total_rows": 1000,
  "failed_at": null,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inserted_at": "2024-05-22T12:00:00Z",
  "name": "Bulk operation name",
  "processed_rows": 0,
  "progress_path": "https://api.switchboard.com/v1/bulk_operations/123e4567-e89b-12d3-a456-426614174000",
  "started_at": null,
  "status": "processing",
  "success_count": 0,
  "updated_at": "2024-05-22T12:00:00Z"
}

Changes

  • 6f88a4142e34Revision changes
    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

  • fcba175ebc76Revision changes
    • breaking

      the request property //////// became not nullable

    • breaking

      the request property //////// became not nullable

    • breaking

      the //////// request property type changed from boolean to no type

    • breaking

      the //////// request property type changed from boolean to no type

    • info

      added subschema #1 subschema #3 to the //////// request property anyOf list

    • info

      added subschema #1 subschema #3 to the //////// request property anyOf list