POST /purchases/{id}/cancel

Owned by Joseph Ioannou (Unlicensed)
Last updated: Mar 20, 2020
1 min read

Available from CRM.COM R16.12.0

This method is used in order to cancel a posted purchase customer event. A single purchase customer event can be canceled by each call

Resource URL

Path Variables

NameTypeDescription
idStringThe purchase customer event identifier (GUID) that will be cancelled

Headers

NameTypeDescription
api_keyString

The api key for API calls to ensure that the client is trusted

  • Providing an API Key, the system should issue an auth token that should be kept until expiration
  • Such auth token should not be passed as part of any of the two APIs, but should be used in order to post such purchase customer event

Body

N/A

Response Data

Name

Type

Description

idStringThe purchase customer event identifier (GUID)

Examples

 Example 1

HTTP Method: POST


Request

Header

api_key: 8c54d563-b991-4b76-8a83-557c08166f95

Body

N/A

Response

{
    "id": "PCE12345678909876544GUID"
}