Giveaways

Get giveaway pool

Changed on

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Retrieve the details of a specified giveaway pool.

get/v1/giveaways/pools/{poolId}

Request

Path parameters

poolIdinteger required

The ID of the pool. You can find it in the Campaign Manager, in the Incentives section.

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

accountIdinteger required

The ID of the account that owns this entity.

namestring required

The name of this giveaway pool.

descriptionstring

The description of this giveaway pool.

subscribedApplicationsIdsinteger[]

A list of the IDs of the Applications that this giveaway pool is enabled for.

sandboxboolean required

Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.

modifiedstring date-time

Timestamp of the most recent update to the giveaway pool.

createdByinteger required

ID of the user who created this giveaway pool.

modifiedByinteger

ID of the user who last updated this giveaway pool if available.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "accountId": 3886,
  "name": "My giveaway pool",
  "description": "Generic pool",
  "subscribedApplicationsIds": [
    2,
    4
  ],
  "sandbox": true
}

Changes