DELETE /api/v1/customfields/{customFieldId}/{collectionName}/{targetId}

This route enables you to remove a custom field and value from a target object.

Servers

Path parameters

Name Type Required Description
customFieldId String Yes

This is the _id of the custom field you want to remove from your target.

collectionName String Yes

This is the type of object you want to modify. Accepted values: users.

targetId String Yes

This is the _id of the object you want to modify.

Query parameters

Name Type Required Description
company String No

(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods.

apiKey String No

(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods.

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.