Skip to content

Function: updateCustomContentPropertyById() ​

ts
function updateCustomContentPropertyById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  id?: string;
  key?: string;
  value?: unknown;
  version?:   | {
   [key: string]: unknown;
     attachment?: Record<string, any>;
     authorId?: string;
     comment?: Record<string, any>;
     contributorIds?: unknown[];
     createdAt?: Date;
     message?: string | null;
     minorEdit?: boolean;
     ncsStepVersion?: string | null;
     number?: number;
   }
     | null;
}>;

Defined in: src/v2/api/contentProperties.ts:575

Update a content property for a piece of custom content by its id.

Permissions required: Permission to edit the custom content.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ customContentId: number; key?: string; propertyId: number; value?: unknown; version?: | { message?: string; number?: number; } | null; }-
parameters.customContentIdnumberThe ID of the custom content the property belongs to.
parameters.key?stringKey of the content property
parameters.propertyId?numberThe ID of the property to be updated.
parameters.value?unknownValue of the content property.
parameters.version?| { message?: string; number?: number; } | nullNew version number and associated message
options?RequestOptions-

Returns ​

Promise&lt;{ [key: string]: unknown; id?: string; key?: string; value?: unknown; version?: | { [key: string]: unknown; attachment?: Record&lt;string, any>; authorId?: string; comment?: Record&lt;string, any>; contributorIds?: unknown[]; createdAt?: Date; message?: string | null; minorEdit?: boolean; ncsStepVersion?: string | null; number?: number; } | null; }>