Apply an action to multiple visitors

Adds or removes a tag, or blocks or unblocks up to 100 visitors from the current organization in one transactional operation.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/visitors/bulk-action" \  -H "Content-Type: application/json" \  -d '{    "action": "add_tag",    "visitorIds": [      "550e8400-e29b-41d4-a716-446655440000"    ],    "tag": "vip"  }'

{
  "success": true,
  "requested": 1,
  "updated": 1
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Try it

Base URLAPI keyRequest body (JSON)

Your API key is sent directly to the Convor API from your browser and is never stored on this site.

Was this page helpful?

Apply an action to multiple visitors

Adds or removes a tag, or blocks or unblocks up to 100 visitors from the current organization in one transactional operation.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

visitorIds*array<>

tag*string

Response Body

`application/json`

curl -X POST "https://example.com/api/visitors/bulk-action" \  -H "Content-Type: application/json" \  -d '{    "action": "add_tag",    "visitorIds": [      "550e8400-e29b-41d4-a716-446655440000"    ],    "tag": "vip"  }'

{
  "success": true,
  "requested": 1,
  "updated": 1
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Try it

Base URLAPI keyRequest body (JSON)

Your API key is sent directly to the Convor API from your browser and is never stored on this site.

Was this page helpful?

Apply an action to multiple visitors

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Apply an action to multiple visitors

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`