> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateCustomFieldApplication # Package: customFields # Namespace: CustomFieldApplications # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/custom-fields/custom-field-applications/update-custom-field-application.md ## Permission Scopes: Manage Members: SCOPE.DC-MEMBERS.MANAGE-MEMBERS ## Introduction Updates a custom field application. Partial updates are not supported. Pass the whole `application` object in the request. --- ## REST API ### Schema ``` Method: updateCustomFieldApplication Description: Updates a custom field application. Partial updates are not supported. Pass the whole `application` object in the request. URL: https://www.wixapis.com/members/v1/custom-fields-applications/{application.customFieldId} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: application, application.customFieldId, application.revision, application.applications.items.entityId, application.exclusions.items.entityId Method parameters: param name: application | type: CustomFieldApplication | description: A custom field application defines which members or entities a custom field applies to. By default, custom fields apply to all members. However, custom field applications allow you to target specific members, roles, badges, or pricing plans, or exclude certain entities. | required: true - name: customFieldId | type: string | description: Custom field GUID. | required: true - name: applications | type: ApplicationsWrapper | description: Entities to which the custom field applies. - name: items | type: array | description: List of up to 100 entities to which the the custom field applies. - name: applicationType | type: Type | description: Type of the application. - enum: - UNKNOWN: Unknown application type. This value isn't used. - ROLE: The field is applied to members with a specific role. - BADGE: The field is applied to members with a specific badge. - PRICING_PLAN: The field is applied to members with a specific pricing plan. - MEMBER: The field is applied to the specified members. - name: entityId | type: string | description: Entity GUID. - name: exclusions | type: ExclusionsWrapper | description: Entities from which the custom field is excluded. - name: items | type: array | description: List of up to 100 entities from which the custom field is excluded. - name: exclusionType | type: Type | description: Type of the exclusion. - enum: - UNKNOWN: Unknown exclusion type. This value isn't used. - ROLE: The field is excluded from members with a specific role. - BADGE: The field is excluded from members with a specific badge. - PRICING_PLAN: The field is excluded from members with a specific pricing plan. - MEMBER: The field is excluded from the specified members. - name: entityId | type: string | description: Entity GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. | required: true Return type: UpdateCustomFieldApplicationResponse - name: application | type: CustomFieldApplication | description: Updated custom field application. - name: customFieldId | type: string | description: Custom field GUID. - name: customFieldKey | type: string | description: Custom field key. - name: applications | type: ApplicationsWrapper | description: Entities to which the custom field applies. - name: items | type: array | description: List of up to 100 entities to which the the custom field applies. - name: applicationType | type: Type | description: Type of the application. - enum: - UNKNOWN: Unknown application type. This value isn't used. - ROLE: The field is applied to members with a specific role. - BADGE: The field is applied to members with a specific badge. - PRICING_PLAN: The field is applied to members with a specific pricing plan. - MEMBER: The field is applied to the specified members. - name: entityId | type: string | description: Entity GUID. - name: exclusions | type: ExclusionsWrapper | description: Entities from which the custom field is excluded. - name: items | type: array | description: List of up to 100 entities from which the custom field is excluded. - name: exclusionType | type: Type | description: Type of the exclusion. - enum: - UNKNOWN: Unknown exclusion type. This value isn't used. - ROLE: The field is excluded from members with a specific role. - BADGE: The field is excluded from members with a specific badge. - PRICING_PLAN: The field is excluded from members with a specific pricing plan. - MEMBER: The field is excluded from the specified members. - name: entityId | type: string | description: Entity GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. ``` ### Examples ### Update a custom field application ```curl curl -X PATCH \ https://www.wixapis.com/members/v1/members/custom-fields-applications/4e4b1840-3833-4dbd-93d1-b2c9a33caa7d \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: ' -d '{ application": { "customFieldId": "4e4b1840-3833-4dbd-93d1-b2c9a33caa7d", "applications": null, "exclusions": { "items": [ { "exclusionType": "ROLE", "entityId": "a7c33e4e-d769-4954-ab87-b3d0492703b4" } ] }, "revision": "1" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.customFields.CustomFieldApplications.updateCustomFieldApplication(customFieldId, application) Description: Updates a custom field application. Partial updates are not supported. Pass the whole `application` object in the request. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: application, customFieldId, application.revision, application.applications.items.entityId, application.exclusions.items.entityId Method parameters: param name: application | type: CustomFieldApplication | description: A custom field application defines which members or entities a custom field applies to. By default, custom fields apply to all members. However, custom field applications allow you to target specific members, roles, badges, or pricing plans, or exclude certain entities. | required: true - name: customFieldId | type: string | description: Custom field GUID. - name: applications | type: ApplicationsWrapper | description: Entities to which the custom field applies. - name: items | type: array | description: List of up to 100 entities to which the the custom field applies. - name: applicationType | type: Type | description: Type of the application. - enum: - UNKNOWN: Unknown application type. This value isn't used. - ROLE: The field is applied to members with a specific role. - BADGE: The field is applied to members with a specific badge. - PRICING_PLAN: The field is applied to members with a specific pricing plan. - MEMBER: The field is applied to the specified members. - name: entityId | type: string | description: Entity GUID. - name: exclusions | type: ExclusionsWrapper | description: Entities from which the custom field is excluded. - name: items | type: array | description: List of up to 100 entities from which the custom field is excluded. - name: exclusionType | type: Type | description: Type of the exclusion. - enum: - UNKNOWN: Unknown exclusion type. This value isn't used. - ROLE: The field is excluded from members with a specific role. - BADGE: The field is excluded from members with a specific badge. - PRICING_PLAN: The field is excluded from members with a specific pricing plan. - MEMBER: The field is excluded from the specified members. - name: entityId | type: string | description: Entity GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. | required: true param name: customFieldId | type: string | description: Custom field GUID. | required: true Return type: PROMISE - name: customFieldId | type: string | description: Custom field GUID. - name: customFieldKey | type: string | description: Custom field key. - name: applications | type: ApplicationsWrapper | description: Entities to which the custom field applies. - name: items | type: array | description: List of up to 100 entities to which the the custom field applies. - name: applicationType | type: Type | description: Type of the application. - enum: - UNKNOWN: Unknown application type. This value isn't used. - ROLE: The field is applied to members with a specific role. - BADGE: The field is applied to members with a specific badge. - PRICING_PLAN: The field is applied to members with a specific pricing plan. - MEMBER: The field is applied to the specified members. - name: entityId | type: string | description: Entity GUID. - name: exclusions | type: ExclusionsWrapper | description: Entities from which the custom field is excluded. - name: items | type: array | description: List of up to 100 entities from which the custom field is excluded. - name: exclusionType | type: Type | description: Type of the exclusion. - enum: - UNKNOWN: Unknown exclusion type. This value isn't used. - ROLE: The field is excluded from members with a specific role. - BADGE: The field is excluded from members with a specific badge. - PRICING_PLAN: The field is excluded from members with a specific pricing plan. - MEMBER: The field is excluded from the specified members. - name: entityId | type: string | description: Entity GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. ``` ### Examples ### updateCustomFieldApplication ```javascript import { customFieldApplications } from '@wix/members'; async function updateCustomFieldApplication(customFieldId,application) { const response = await customFieldApplications.updateCustomFieldApplication(customFieldId,application); }; ``` ### updateCustomFieldApplication (with elevated permissions) ```javascript import { customFieldApplications } from '@wix/members'; import { auth } from '@wix/essentials'; async function myUpdateCustomFieldApplicationMethod(customFieldId,application) { const elevatedUpdateCustomFieldApplication = auth.elevate(customFieldApplications.updateCustomFieldApplication); const response = await elevatedUpdateCustomFieldApplication(customFieldId,application); } ``` ### updateCustomFieldApplication (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { customFieldApplications } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { customFieldApplications }, // Include the auth strategy and host as relevant }); async function updateCustomFieldApplication(customFieldId,application) { const response = await myWixClient.customFieldApplications.updateCustomFieldApplication(customFieldId,application); }; ``` ---