Update conversion goal

PATCH

/api/v1/conversions/goals/{id}

const url = 'https://example.com/api/v1/conversions/goals/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Purchase","key":"purchase","description":"User completed a purchase","isActive":true,"collectionId":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/api/v1/conversions/goals/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Purchase", "key": "purchase", "description": "User completed a purchase", "isActive": true, "collectionId": {} }'

Authorizations

bearer

Parameters

Path Parameters

required

string

Goal UUID

Request Body^required

application/json

object

name

string

<= 100 characters

Example

Purchase

key

URL-safe slug (3-50 chars, lowercase alphanumeric, hyphens, underscores)

string

Example

purchase

description

string

Example

User completed a purchase

isActive

boolean

Example

true

collectionId

Set to a collection UUID to scope, or null to unscope

object

Responses

200

Goal updated

Update conversion goal

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example

Example

Example

Example

Responses

200

Request Body^required