TAtalon
Collections

Update campaign-level collection's description

[!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.

Edit the description of a given campaign-level collection.

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

Request

Path parameters

applicationIdinteger required

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

campaignIdinteger required

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

collectionIdinteger required

The ID of the collection. You can get it with the List collections in Application endpoint.

Request body

descriptionstring

A short description of the purpose of this collection.

Example request

{
  "description": "My collection of SKUs"
}

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.

modifiedstring date-time required

The time this entity was last modified.

descriptionstring

A short description of the purpose of this collection.

subscribedApplicationsIdsinteger[]

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

namestring required

The name of this collection.

modifiedByinteger

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

createdByinteger required

ID of the user who created this effect.

applicationIdinteger

The ID of the Application that owns this entity.

campaignIdinteger

The ID of the campaign that owns this entity.

payloadstring[]

The content of the collection.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "accountId": 3886,
  "modified": "2021-09-12T10:12:42Z",
  "description": "My collection of SKUs",
  "subscribedApplicationsIds": [
    1,
    2,
    3
  ],
  "name": "My collection",
  "modifiedBy": 48,
  "createdBy": 134,
  "applicationId": 1,
  "campaignId": 7,
  "payload": [
    "KTL-WH-ET-1",
    "KTL-BL-ET-1"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.