Activations

The Activation API allows you to create, retrieve, and delete activations.

Available since: v2.23.0

Creates a new activation.

In current release only request activation is supported

Endpoint

POST /api/activations

Headers

• Content-Type: application/json
• Accept: application/vnd.blockgraph.v1+json
• Authorization: Bearer {access-token

Request Body

Name	Type	Required	Restrictions	Description
campaignName	string	false	200 Characters	name of the campaign
agency	string	false	200 Characters	name of the agency
brand	string	false	200 Characters	name of the brand
activationName	string	true	200 Characters	name of the activation
segmentId	string	true	none	id of segment, can get from match endpoint
matchJobId	string	true	none	id of match job, can get from match endpoint
campaignStartDate	string(date-time)	false	none	start date of campaign, example: "2025-06-01T00:00:00Z"
campaignEndDate	string(date-time)	false	none	end date of campaign, example: "2025-06-30T23:59:59Z"
refreshRate	integer(int32)	yes	0/30/60/90	refresh rate of activation
actionType	string	yes	REQUEST	refresh rate of activation

Possible Responses

Status	Meaning	Description	Schema
200	OK	A ResponseEntity containing a JobStatusResponse with details about the created activation job if successful,
or a 404 Not Found response if the match could not be found	JobStatusResponse
400	Bad Request	Bad Request	Inline
500	Internal Server Error	Internal Server Error	Description of the activation

Example Request

# You can also use wget
curl -X POST https://api.{participant id}.blockgraph.app/api/activations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/vnd.blockgraph.v1+json' \
  -H 'Authorization: Bearer {access-token}'
    -d '{
  "campaignName": "string",
  "agency": "string",
  "brand": "string",
  "activationName": "string",
  "segmentId": "string",
  "matchJobId": "string",
  "campaignStartDate": "2019-08-24T14:15:22Z",
  "campaignEndDate": "2019-08-24T14:15:22Z",
  "refreshRate": 0,
  "actionType": "REQUEST"
}'

Response

200 Response

{
  "id": "string",
  "status": "PENDING"
}

400 Response

Deletes a activation by its ID.

Endpoint

DELETE /api/activations/{id}

Header

• 'Accept: *
• 'Authorization: Bearer {access-token}

Request Body

Name	In	Type	Required	Description
id	path	integer(int64)	true	The ID of the activation to delete.

Possible Responses

Status	Meaning	Description	Schema
200	OK	A "No Content" (200) response if successful, or a "Not Found" (404) response if the activation does not exist.	None
400	Bad Request	Bad Request	Inline
500	Internal Server Error	Internal Server Error	Description of the activation

Example Request

# You can also use wget
curl -X DELETE https://api.{participant id}.blockgraph.app/api/activations/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

Response

Retrieves activation based on id.

Endpoint

GET /api/activations/{id}

Headers

• Accept: application/vnd.blockgraph.v1+json
• Authorization: Bearer {access-token}

Request Body

Name	In	Type	Required	Description
id	path	integer(int64)	true	none

Possible Responses

Status	Meaning	Description	Schema
200	OK	A response containing a list of activations that match the filter criteria.	Activation
400	Bad Request	Bad Request	Inline
500	Internal Server Error	Internal Server Error	Description of the activation

Example Request

# You can also use wget
curl -X GET https://api.{participant id}.blockgraph.app/api/activations/{id} \
  -H 'Accept: application/vnd.blockgraph.v1+json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

{
  "myRole": "Requester",
  "ActivationId": "123",
  "ActivationName": "123 Hashed IP",
  "Status": "Activated",
  "spi": false,
  "deliveryScopes": [
    "NONE"
  ],
  "campaign": null,
  "agency": null,
  "brand": null
}

400 Response

Retrieves all activations based on query parameters.

Endpoint

GET /api/activations

Headers

• Accept: application/vnd.blockgraph.v1+json
• Authorization: Bearer {access-token}

Request Body

Name	Type	Required	Restrictions	Description
page	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none

Possible Responses

Status	Meaning	Description	Schema
200	OK	A response containing a list of activations that match the filter criteria.	ActivationResponse
400	Bad Request	Bad Request	Inline
500	Internal Server Error	Internal Server Error	Description of the activation

Example Request

# You can also use wget
curl -X GET https://api.{participant id}.blockgraph.app/api/activations/activations?params=page,1000,pageSize,10 \
  -H 'Accept: application/vnd.blockgraph.v1+json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

{
  "activations": [
    {
      "myRole": "Requester",
      "ActivationId": "123",
      "ActivationName": "testActivation1",
      "Status": "Activated",
      "spi": true,
      "deliveryScopes": [],
      "campaign": null,
      "agency": null,
      "brand": null
    },
    {
      "myRole": "Requester",
      "ActivationId": "456",
      "ActivationName": "testActivation1",
      "Status": "Activated",
      "spi": true,
      "deliveryScopes": [],
      "campaign": null,
      "agency": null,
      "brand": null
    }
  ],
  "page": 0,
  "pageSize": 0,
  "hasMore": true
}

400 Response