Class CustomPropertyStructures

constructor

• new CustomPropertyStructures(fetch: FetchFunction): CustomPropertyStructures

  Create a new CustomPropertyStructures instance.

  Parameters

  • fetch: FetchFunction

    Function for making API requests

  Returns CustomPropertyStructures

Readonlyitems

create

• create(
      body: CreateCustomPropertyStructureBody,
  ): Promise<CustomPropertyStructure>

  Create a custom property structure for an organization. Only one structure can exist per (associatedType, belongerType, belongerId) combination — a duplicate fails with IM005. Once created, a structure cannot be deleted through the API.

  Parameters

  • body: CreateCustomPropertyStructureBody

    The structure to create

  Returns Promise<CustomPropertyStructure>

  Promise with the created custom property structure

  Example

  const structure = await make.customPropertyStructures.create({
      associatedType: 'scenario',
      belongerType: 'organization',
      belongerId: 123,
  });
  Copy

list

• list(organizationId: number): Promise<CustomPropertyStructure[]>

  List the custom property structures of an organization. The API does not support column selection or pagination for this endpoint. Requires the organization's custom-properties feature to be enabled (error IM027 otherwise).

  Parameters

  • organizationId: number

    The organization ID to list custom property structures for

  Returns Promise<CustomPropertyStructure[]>

  Promise with the list of custom property structures

  Example

  const structures = await make.customPropertyStructures.list(123);
  Copy