Sign in
Events

Set event currency

Set the currency of an event by its name. Use this instead of updating an event by its goal code. If more than one event row shares the name, they are treated as one event and every matching row is updated.

Permissions: Requires write access to the site (manage:{site_id}).

Returns: Returns an updated object on success. Otherwise, this call returns an error.

post/sites/{site_id}/events/currency

Path parameters

site_idstring required
Example:CDBUGS

The ID of the site. This is the same string you use in your tracking code. Example: CDBUGS

Request body

namestring required

The name of the event (up to 255 characters). Example: Purchase early access

currency'dollar' | 'pound' | 'euro' | 'yuan' | 'peso' | 'shekel' | 'yen' | 'won' | 'hryvnia' | 'franc' | 'rupee' | 'integer' | 'none' required

The currency used for any value attached to this event's completions.

Example request

{
  "name": "Purchase early access",
  "currency": "pound"
}

Response

Successful response

Changes

Changed in 1 of the 2 revisions of this API.1