findOrCreateLabel( )

Retrieves a label with a specified name, or creates one if it doesn't exist.

Successful calls to this method always return a label, which can be specified in subsequent calls.

For example, in the Contacts API, Label Contact and Unlabel Contact calls will fail if you include a non-existent label. To ensure successful calls, you can call this method first, and then use the response in the Label Contact and Unlabel Contact calls.

To find an existing label without potentially creating a new one, call Get Label or Query Labels.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Members and Contacts - all permissions
Manage Contact Labels
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
displayNamestringRequired

Display name to retrieve or create.

If an existing label is an exact match for the specified display name, the existing label is returned. If not, a new label is created and returned.

optionsFindOrCreateLabelOptions

Language options.

Returns
Return Type:Promise<FindOrCreateLabelResponse>
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?