younifyd
Menu

Get Collection

Get campaign-level collection

GET/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Collection action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getCollection.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger (int64)required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

collectionIdinteger (int64)required

The ID of the collection. You can get it with the [List collections in Application](#tag/Collections/operation/listCollectionsInApplication) endpoint.

Response

Returns 200 with an object. Read it in later steps with {{getCollection.response.data.<field>}}.

idinteger (int64)

The internal ID of this entity.

createdstring (date-time)

The time this entity was created.

accountIdinteger (int64)

The ID of the account that owns this entity.

modifiedstring (date-time)

The time this entity was last modified.

descriptionstring

A short description of the purpose of this collection.

subscribedApplicationsIdsarray<integer (int64)>

A list of the IDs of the Applications where this collection is enabled.

namestring

The name of this collection.

modifiedByinteger (int64)

ID of the user who last updated this effect if available.

createdByinteger (int64)

ID of the user who created this effect.

applicationIdinteger (int64)

The ID of the Application that owns this entity.

campaignIdinteger (int64)

The ID of the campaign that owns this entity.

payloadarray<string>

The content of the collection.

json
{
  "id": 6,
  "created": {},
  "accountId": 3886,
  "modified": {},
  "name": "My collection",
  "createdBy": 134,
  "description": "My collection of SKUs",
  "subscribedApplicationsIds": [
    1,
    2,
    3
  ],
  "modifiedBy": 48,
  "applicationId": 1,
  "campaignId": 7,
  "payload": [
    "KTL-WH-ET-1",
    "KTL-BL-ET-1"
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.