campaigns

Get a campaign

Get one campaign by campaignId.

get/v1/campaigns/{campaignId}

Path parameters

campaignIdinteger required

Campaign id

Response

successful operation

idinteger

namestring

keystring

descriptionstring

reductioninteger

customDataobject

start_atstring

end_atstring

Example response

{
  "id": 20201,
  "name": "Summer_Campaign",
  "description": "10% discount for all summer products",
  "reduction": 10,
  "start_at": "2021-04-13T08:45:00+00:00",
  "end_at": "2021-05-13T08:45:00+00:00"
}

Changes

Changed in 3 of the 3 revisions of this API.35

Jul 17, 20268cfa924ae7031See the full diff
- ○
  added the non-success response with the status 401
  response-non-success-status-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 2023beabe21499473See the full diff
- ●
  removed the optional property customData/newField1 from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property customData/newField2 from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property customData/prices from the response with the 200 status
  response-optional-property-removed
Aug 6, 2023302b7c443b514See the full diff
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  added the optional property customData/newField1 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property customData/newField2 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property customData/prices to the response with the 200 status
  response-optional-property-added
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history