PUT /api/v1/meta/types/user/{typeId}

Replaces an existing User Type. This operation is a full update.

Note: The name of an existing User Type can't be changed, but must be part of the request body. You can only replace the displayName and description elements.

Servers

Path parameters

Name Type Required Description
typeId String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

The name of the existing type

description String Yes

The human-readable description of the User Type

displayName String Yes

The human-readable name of the User Type

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.