▲ Top

User Custom Fields

This section describes the following services related to User Custom Fields:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Find User Custom Fields

GET /user/customfields

Description

Find User Custom Fields.

Resource Information

HTTP Method GET
Resource Family user/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

GET https://sandbox.e-signlive.com/api/user/customfields

Find a User Custom Field by ID

GET /user/customfields/{customFieldId}

Description

Find a User Custom Field by its ID.

Resource Information

HTTP Method GET
Resource Family user/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

customeFieldId Unique identifier of a Custom Field

Example Request

GET https://sandbox.e-signlive.com/api/user/customfields/Notes

Add a User Custom Field

POST /user/customfields

Description

Add a User Custom Field.

Resource Information

HTTP Method POST
Resource Family user/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

POST https://sandbox.e-signlive.com/api/user/customfields

Update a User Custom Field

PUT /user/customfields

Description

Update a User Custom Field.

Resource Information

HTTP Method PUT
Resource Family user/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

PUT https://sandbox.e-signlive.com/api/user/customfields

Delete a User Custom Field by ID

DELETE /user/customfields/{customFieldId}

Description

Delete a User Custom Field by its ID.

Resource Information

HTTP Method DELETE
Resource Family user/customfields
Authentication Required
Content-type application/json
Accept application/json

Path Parameters

customeFieldId Unique identifier of a Custom Field

Example Request

DELETE https://sandbox.e-signlive.com/api/user/customfields/Notes

Response Payload

no content