Remove a custom field from a goal

1 body field

Information about the custom field setting to remove from the goal.

dataobjectoptional

The payload containing the custom field setting identifier.

6 status codes

200Returns an empty object after the custom field setting is removed from the goal.

dataobjectoptional

An empty object. Some endpoints do not return an object on success. The success is conveyed through a 2-- status code and returning an empty object.

400Returned when the `custom_field` value is missing or malformed.

errorsarray<object>optional

401Returned when the request does not include a valid authentication token.

errorsarray<object>optional

403Returned when the authenticated user lacks access or the `goals:write` scope.

errorsarray<object>optional

404Returned when the request does not specify a known action or the specified object does not exist.

errorsarray<object>optional

500Returned when a server-side problem prevents the custom field setting from being removed.

errorsarray<object>optional

Error handling

The custom_field field is required and must identify the custom field setting to remove. A 400 is returned for a missing or malformed value, a 401 for missing authentication, a 403 without access or the goals:write scope, a 404 for an unknown action or object, and a 500 for a server-side failure.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    clientId: process.env.CLIENT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.removeCustomFieldSetting.create({
  goalGid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  data: {},
});

{
  "data": {}
}

Request

Response

Errors