Sign in

v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
BulkTeamOperations

Retrieve bulk team operation status

This endpoint retrieves the status of a bulk team operation using its bulk ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. Use this endpoint to check the progress and completion status of bulk update operations.

get/v2/teams/bulk/status/{id}

Path parameters

idstring required

The unique identifier of the bulk operation.

Query parameters

pageTokenstring

Pagination token to retrieve the next page of results.

pageSizestring int64

The number of items to retrieve per page.

statusstring

Filter items by status (e.g., BULK_ITEM_SUCCESS, BULK_ITEM_FAILED).

Response

Details of the bulk operation status and progress.

bulkIdstring

Unique identifier for the bulk operation.

resource'BULK_OPERATION_RESOURCE_BILLING' | 'BULK_OPERATION_RESOURCE_CAMPAIGN' | 'BULK_OPERATION_RESOURCE_AUTH'
operationType'BULK_OPERATION_TYPE_CAMPAIGN_UPDATE' | 'BULK_OPERATION_TYPE_CAMPAIGN_STATE_UPDATE' | 'BULK_OPERATION_TYPE_WALLET_UPDATE' | 'BULK_OPERATION_TYPE_TEAM_UPDATE' | 'BULK_OPERATION_TYPE_WALLET_CREATE' | 'BULK_OPERATION_TYPE_TEAM_CREATE' | 'BULK_OPERATION_TYPE_CAMPAIGN_CREATE' | 'BULK_OPERATION_TYPE_INVITE_USER' | 'BULK_OPERATION_TYPE_REMOVE_USER'
status'BULK_OPERATION_SUBMITTED' | 'BULK_OPERATION_IN_PROGRESS' | 'BULK_OPERATION_COMPLETED' | 'BULK_OPERATION_FAILED'
totalCountstring int64

Total number of items in the bulk operation.

successCountstring int64

Number of items processed successfully.

failureCountstring int64

Number of items that failed processing.

createdAtstring date-time

Timestamp when the bulk operation was created.

updatedAtstring date-time

Timestamp when the bulk operation was last updated.

nextPageTokenstring

Token to retrieve the next page of results.

Example response

{
  "items": [
    {
      "createTeamRequest": {
        "id": "team_001XYZ",
        "name": "Development Team",
        "namespaceId": "namespace_ABC123",
        "companyName": "Innovative Solutions Ltd.",
        "companyWebsite": "https://www.innovativesolutions.com",
        "companyPhone": "+1-234-567-8901",
        "companyAddress": {
          "addressLine": "123 Main St",
          "postcode": "12345"
        },
        "logoId": "logo_567XYZ",
        "businessIdentifier": "biz_AB12345",
        "reviewerEmail": "reviewer@innovativesolutions.com",
        "sellerId": "seller_990XYZ",
        "modifyTime": "2024-02-14T23:45:01Z",
        "onBehalfOf": "Ad Sponsor Ltd."
      },
      "updateTeamRequest": {
        "id": "team_123XYZ",
        "name": "Alpha Team",
        "namespaceId": "namespace_987ABC",
        "companyName": "Awesome Corp",
        "companyWebsite": "https://www.awesomecorp.com",
        "companyPhone": "+1-800-555-0123",
        "companyAddress": {
          "addressLine": "123 Main St",
          "postcode": "12345"
        },
        "businessIdentifier": "biz_456XYZ",
        "reviewerEmail": "reviewer@example.com",
        "logoId": "biz_456XYZ",
        "sellerId": "seller_789LMN",
        "modifyTime": "2024-09-01T12:34:56Z",
        "onBehalfOf": "Sponsor Corp"
      },
      "inviteUserRequest": {
        "managerTeamId": "manager-team-123",
        "roleIds": [
          "ROLE_TYPES_SUPPLIER_FULL",
          "ROLE_TYPES_RETAILER_REPORT_VIEW"
        ],
        "teamId": "team-456",
        "emailToInvite": "invitee@example.com",
        "inviteUrl": "https://campaign.citrusad.com/user/invite"
      },
      "removeUserRequest": {
        "teamId": "team-456",
        "userId": "user-456"
      }
    }
  ]
}