cURL

curl --request POST \
  --url https://api.mindshare.so/customer/v1/update-query-group-status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "queryGroupId": 123,
  "status": "Active"
}
'

{
  "data": {
    "message": "<string>"
  },
  "version": "<string>",
  "env": "<string>"
}

Management

Update Query Group Status

Updates the status of an existing query group.

A query group represents a set of related queries for a specific product line or campaign. Customers can have multiple query groups. The caller must own the query group through their organization — the system validates that the query group belongs to a customer within the caller’s organization.

Note: Changing status to Active consumes one credit from the organization’s quota. Changing status to Pause or Not Active frees one credit back to the quota.

POST

update-query-group-status

cURL

curl --request POST \
  --url https://api.mindshare.so/customer/v1/update-query-group-status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "queryGroupId": 123,
  "status": "Active"
}
'

{
  "data": {
    "message": "<string>"
  },
  "version": "<string>",
  "env": "<string>"
}

Authorizations

X-API-Key

string

header

required

Body

application/json

Query Group status update details

queryGroupId

number

required

The ID of the query group to update.

status

enum<string>

required

The new status for the query group.

Available options:

Active,

Not Active,

Pause

Response

200 - application/json

Query group status updated successfully

data

object

required

Response details

Show child attributes

version

string

required

API version

env

string

required

Environment name

Update Query Group Name Edit Queries Definitions

API documentation

Endpoints

Use Cases

Update Query Group Status

Authorizations

Body

Response