Skip to main content

Enboarder API Docs: Settings APIs

Use these APIs to sync your Categories, Custom Fields, Locations and Brands with your core system

Chris Jones avatar
Written by Chris Jones
Updated over 10 months ago

This API doc covers the following topics below, feel free to click on the hyperlink to skip to that section. ✔

  1. Get, create, update and delete brands

  2. Get, create, update and delete locations

  3. Get, create, update and delete categories

  4. Get, create, update and delete custom fields

Brand Endpoints

Base URL:

AU 🇦🇺 : https://api.syd.e1.enboarder.com/restapi/v1/settings

EU 🇪🇺 : https://api.fra.e1.enboarder.com/restapi/v1/settings

US 🇺🇸 : https://api.ore.e1.enboarder.com/restapi/v1/settings

CA 🇨🇦 : https://api.can.e1.enboarder.com/restapi/v1/settings

Get Brands

Report End Point:

{{baseURL}}/brand/all

HTTP Method: GET

Description: To get a list of brands from your Enboarder account

Parameters: None

Sample Response:

Code

Body

200

EXAMPLE VALUE:

[
{
"id": "val_brand_a8t-wBc6n",
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logo": "https://static.enboarder.net/images/default-comp-logo.png",
"icon": "https://static.enboarder.net/images/default-comp-icon.png",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}
]

404

Forbidden

Get Brand by ID

Report End Point:

{{baseURL}}/brand/byid/{id}

HTTP Method: GET

Description: To get a specific brand with an ID in your Enboarder account

Parameters:

Name

Description

id

Identifier of the brand

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "val_brand_a8t-wBc6n",
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logo": "https://static.enboarder.net/images/default-comp-logo.png",
"icon": "https://static.enboarder.net/images/default-comp-icon.png",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

400

EXAMPLE VALUE

{
  "field": "id",
  "message": "Brand item with 'id' does not exist"
}

403

Forbidden

Get Brand by name

Report End Point:

{{baseURL}}/brand/byname/{name}

HTTP Method: GET

Description: To get a specific brand with a name in your Enboarder account

Parameters:

Name

Description

name

Name of the brand

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "val_brand_a8t-wBc6n",
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logo": "https://static.enboarder.net/images/default-comp-logo.png",
"icon": "https://static.enboarder.net/images/default-comp-icon.png",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

400

EXAMPLE VALUE

{
  "field": "name",
  "message": "Brand item with 'name' does not exist"
}

403

Forbidden

Create Brands

Report End Point:

{{baseURL}}/brand

HTTP Method: POST

Description: To create brands in your Enboarder account

Parameters: None

Request body (required):

EXAMPLE VALUE

{
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logobase64": "iVBORw0KGgoAAAANSUhEUgAAACUAAAAbCAYAAAD77kbeAAAGKUlEQVRYCc2Xy29VVRTGv7Xvva1RAyJULG15...",
"iconbase64": "iVBORw0KGgoAAAANSUhEUgAAACUAAAAbCAYAAAD77kbeAAAGKUlEQVRYCc2Xy29VVRTGv7Xvva1RAyJULG15...",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

Sample Response:

Code

Body

201

EXAMPLE VALUE

{
"id": "val_brand_a8t-wBc6n",
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logo": "https://static.enboarder.net/images/default-comp-logo.png",
"icon": "https://static.enboarder.net/images/default-comp-icon.png",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

409

EXAMPLE VALUE

{
  "field": "name",
   "message": "Brand item with same 'name' already exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Update Brands with ID

Report End Point:

{{baseURL}}/brand/byid/{id}

HTTP Method: PUT

Description: To update brands in your Enboarder account using a brand ID

Parameters:

Name

Description

id

Id of the brand

Request body (required):

EXAMPLE VALUE

{
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logobase64": "iVBORw0KGgoAAAANSUhEUgAAACUAAAAbCAYAAAD77kbeAAAGKUlEQVRYCc2Xy29VVRTGv7Xvva1RAyJULG15...",
"iconbase64": "iVBORw0KGgoAAAANSUhEUgAAACUAAAAbCAYAAAD77kbeAAAGKUlEQVRYCc2Xy29VVRTGv7Xvva1RAyJULG15...",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "val_brand_a8t-wBc6n",
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logo": "https://static.enboarder.net/images/default-comp-logo.png",
"icon": "https://static.enboarder.net/images/default-comp-icon.png",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

404

EXAMPLE VALUE

{
  "field": "id",
  "message": "Brand item with 'id' does not exists"
}

409

EXAMPLE VALUE

{
  "field": "id",
  "message": "Brand item with same 'id' already exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Update Brands with name

Report End Point:

{{baseURL}}/brand/byname/{name}

HTTP Method: PUT

Description: Updates an existing brand with name provided. To remove attributes from a brand, the attribute has to be passed in the payload with no value or empty string.

Parameters:

Name

Description

name

Name of the brand

Request body (required):

EXAMPLE VALUE

{
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logobase64": "iVBORw0KGgoAAAANSUhEUgAAACUAAAAbCAYAAAD77kbeAAAGKUlEQVRYCc2Xy29VVRTGv7Xvva1RAyJULG15...",
"iconbase64": "iVBORw0KGgoAAAANSUhEUgAAACUAAAAbCAYAAAD77kbeAAAGKUlEQVRYCc2Xy29VVRTGv7Xvva1RAyJULG15...",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "val_brand_a8t-wBc6n",
"name": "Microsoft",
"btnbg": "#999999",
"btnfg": "#FFFFFF",
"headerbg": "#999999",
"headerfg": "#FFFFFF",
"logo": "https://static.enboarder.net/images/default-comp-logo.png",
"icon": "https://static.enboarder.net/images/default-comp-icon.png",
"emailfrom": "Microsoft Corporation",
"smsfrom": "microsoft",
"shortdomain": "microsoft",
"shortsubdomain": "microsoft",
"addhttp": "yes"
}

409

EXAMPLE VALUE

{
  "field": "name",
  "message": "Brand item with same 'name' already exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Delete Brands with ID

Report End Point:

{{baseURL}}/brand/byid/{id}

HTTP Method: DELETE

Description: To delete existing brands in your Enboarder account using a brand ID

Request body: None

Parameters:

Name

Description

id

Id of the brand

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
  "name": "Microsoft",
  "id": "val_brand_a8t-wBc6n"
}

404

EXAMPLE VALUE

{
  "field": "id",
  "message": "Brand item with 'id' does not exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "id",
  "message": "should have required property 'id'"
}

403

Forbidden

Delete Brands with name

Report End Point:

{{baseURL}}/brand/byid/{name}

HTTP Method: DELETE

Description: To delete existing brands in your Enboarder account using a brand name

Request body: None

Parameters:

Name

Description

Name

Name of the brand

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
  "name": "Microsoft",
  "id": "val_brand_a8t-wBc6n"
}

404

EXAMPLE VALUE

{
  "field": "name",
  "message": "Brand item with 'name' does not exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Location Endpoints

Base URL:

AU 🇦🇺 : https://api.syd.e1.enboarder.com/restapi/v1/settings

EU 🇪🇺 : https://api.fra.e1.enboarder.com/restapi/v1/settings

US 🇺🇸 : https://api.ore.e1.enboarder.com/restapi/v1/settings

CA 🇨🇦 : https://api.can.e1.enboarder.com/restapi/v1/settings

Timezones

Model

Name

Type

k

string (id)

v

string

Report End Point:

{{baseURL}}/timezones

HTTP Method: GET

Description: Get timezones supported in Enboarder

Parameters: None

Sample Response:

Code

Body

200

Example value:

[
{
"k": "Australia/Sydney",
"v": "Australia/Sydney (+10:00)"
},
{
"k": "US/Eastern",
"v": "US/Eastern (-04:00)"
}
]

Locations

Model

Location

Name

Type

id

string

name

string (unique)

tz

Timezone id(k)

city

string

state

string

country

string

address

string

postcode

string or integer

Report End Point:

{{baseURL}}/location/all

HTTP Method: GET

Description: Get locations present in your Enboarder account

Parameters: None

Sample Response:

Code

Body

200

Example value:

[
{
"id": "val_location_a8t-wBc6n",
"name": "New York Central",
"tz": "US/Eastern",
"city": "New York",
"state": "New York",
"country": "United States",
"address": "101, Wall Street, Manhattan",
"postcode": 10001
},
{
"id": "val_location_p8IWlb_lQ",
"name": "Sydney CBD",
"tz": "Australia/Sydney"
}
]

404

Forbidden

Creating a location

Report End Point:

{{baseURL}}/location

HTTP Method: POST

Description: Create locations in your Enboarder account

Parameters: None

Request body (required):

EXAMPLE VALUE:

{
"name": "New York Central",
"tz": "US/Eastern",
"city": "New York",
"state": "New York",
"country": "United States",
"address": "101, Wall Street, Manhattan",
"postcode": 10001
}

Sample Response:

Code

Body

201

Example value

{
  "id": "val_location_a8t-wBc6n",
  "name": "New York Central",
  "tz": "US/Eastern",
  "city": "New York",
  "state": "New York",
  "country": "United States",
  "address": "101, Wall Street, Manhattan",
  "postcode": 10001
}

409

Example value

{
  "field": "name",
   "message": "Location item with same 'name' already exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Get locations by ID

Report End Point:

{{baseURL}}/location/byid/{id}

HTTP Method: GET

Description: Get location present in your Enboarder account by ID

Parameters:

Name

Description

id

Identifier of the location

Sample Response:

Code

Body

200

Example value

{
  "id": "val_location_a8t-wBc6n",
  "name": "New York Central",
  "tz": "US/Eastern",
  "city": "New York",
  "state": "New York",
  "country": "United States",
  "address": "101, Wall Street, Manhattan",
  "postcode": 10001
}

400

Example value

{
  "field": "id",
  "message": "Location item with 'id' does not exist"
}

403

Forbidden

Get locations by name

Report End Point:

{{baseURL}}/location/byname/{name}

HTTP Method: GET

Description: Get location present in your Enboarder account by name

Parameters:

Name

Description

name

Name of the location

Sample Response:

Code

Body

200

Example value

{
  "id": "val_location_a8t-wBc6n",
  "name": "New York Central",
  "tz": "US/Eastern",
  "city": "New York",
  "state": "New York",
  "country": "United States",
  "address": "101, Wall Street, Manhattan",
  "postcode": 10001
}

400

Example value

{
  "field": "name",
  "message": "Location item with 'name' does not exist"
}

403

Forbidden

Update locations by ID

Report End Point:

{{baseURL}}/location/byid/{id}

HTTP Method: PUT

Description: Updates an existing location in your Enboarder account by ID

Parameters:

Name

Description

id

Id of the location

Request body (required):

EXAMPLE VALUE

{
"name": "New York Central",
"tz": "US/Eastern",
"city": "New York",
"state": "New York",
"country": "United States",
"address": "101, Wall Street, Manhattan",
"postcode": 10001
}

Sample Response:

Code

Body

200

Example value

{
  "id": "val_location_a8t-wBc6n",
  "name": "New York Central",
  "tz": "US/Eastern",
  "city": "New York",
  "state": "New York",
  "country": "United States",
  "address": "101, Wall Street, Manhattan",
  "postcode": 10001
}

404

Example value

{
  "field": "id",
  "message": "Location item with 'id' does not exists"
}

409

Example value

{
  "field": "id",
  "message": "Location item with same 'id' already exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Update locations by name

Report End Point:

{{baseURL}}/location/byname/{name}

HTTP Method: PUT

Description: Updates an existing location in your Enboarder account by name

Parameters:

Name

Description

name

Name of the location

Request body (required):

EXAMPLE VALUE

{
"name": "New York Central",
"tz": "US/Eastern",
"city": "New York",
"state": "New York",
"country": "United States",
"address": "101, Wall Street, Manhattan",
"postcode": 10001
}

Sample Response:

Code

Body

200

Example value

{
  "id": "val_location_a8t-wBc6n",
  "name": "New York Central",
  "tz": "US/Eastern",
  "city": "New York",
  "state": "New York",
  "country": "United States",
  "address": "101, Wall Street, Manhattan",
  "postcode": 10001
}

409

Example value

{
  "field": "name",
  "message": "Location item with same 'name' already exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Delete locations by ID

Report End Point:

{{baseURL}}/location/byid/{id}

HTTP Method: DELETE

Description: Deletes an existing location in your Enboarder account by ID

Parameters:

Name

Description

id

Id of the location

Sample Response:

Code

Body

200

Example value

{
  "name": "New York Central",
  "id": "val_location_a8t-wBc6n"
}

404

Example value

{
  "field": "id",
  "message": "Location item with 'id' does not exists"
}

400

Example value

{
  "errorType": "required",
  "field": "id",
  "message": "should have required property 'id'"
}

403

Forbidden

Delete locations by name

Report End Point:

{{baseURL}}/location/byname/{name}

HTTP Method: DELETE

Description: Deletes an existing location in your Enboarder account by name

Parameters:

Name

Description

Name

Name of the location

Sample Response:

Code

Body

200

Example value

{
  "name": "New York Central",
  "id": "val_location_a8t-wBc6n"
}

404

Example value

{
  "field": "name",
  "message": "Location item with 'name' does not exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Categories Endpoints

Base URL:

AU 🇦🇺 : https://api.syd.e1.enboarder.com/restapi/v1/settings

EU 🇪🇺 : https://api.fra.e1.enboarder.com/restapi/v1/settings

US 🇺🇸 : https://api.ore.e1.enboarder.com/restapi/v1/settings

CA 🇨🇦 : https://api.can.e1.enboarder.com/restapi/v1/settings

MODEL

Name

Type

id

string

name

string (unique)

attr

array

Get a list of categories in your Enboarder account

Report End Point:

{{baseURL}}/category/all

HTTP Method: GET

Description: Get categories present in your Enboarder account

Parameters: None

Sample Response:

Code

Body

200

EXAMPLE VALUE:

[
{
"id": "sadfegawfg",
"name": "Division",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}
]

404

Forbidden

Create a new category

Report End Point:

{{baseURL}}/category

HTTP Method: POST

Description: Get categories present in your Enboarder account

Parameters: None

Request body (required):

EXAMPLE VALUE

{
"name": "Division",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

Sample Response:

Code

Body

201

EXAMPLE VALUE:

{
"name": "Division",
"id": "sadfegawfg",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

409

EXAMPLE VALUE

{
  "field": "name",
   "message": "Category item with same 'name' already exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Get categories present in account by ID

Report End Point:

{{baseURL}}/category/byid/{id}

HTTP Method: GET

Description: Get categories present in your Enboarder account by ID

Parameters:

Name

Description

id

Identifier of the category

Sample Response:

Code

Body

200

EXAMPLE VALUE:

{
"name": "Division",
"id": "sadfegawfg",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

400

EXAMPLE VALUE

{
  "field": "id",
  "message": "Category item with 'id' does not exist"
}

403

Forbidden

Get categories present in account by name

Report End Point:

{{baseURL}}/category/byname/{name}

HTTP Method: GET

Description: Get categories present in your Enboarder account by name

Parameters:

Name

Description

name

Name of the category

Sample Response:

Code

Body

200

EXAMPLE VALUE:

{
"name": "Division",
"id": "sadfegawfg",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

400

EXAMPLE VALUE

{
  "field": "name",
  "message": "Category item with 'name' does not exist"
}

403

Forbidden

Updating categories present in account by ID

Report End Point:

{{baseURL}}/category/byid/{id}

HTTP Method: PUT

Description: Update categories present in your Enboarder account by ID

Parameters:

Name

Description

id

Id of the c

Request body (required):

EXAMPLE VALUE:

{
"name": "Division",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

Sample Response:

Code

Body

200

EXAMPLE VALUE:

{
"name": "Division",
"id": "sadfegawfg",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

404

EXAMPLE VALUE

{
  "field": "id",
  "message": "Category item with 'id' does not exists"
}

409

EXAMPLE VALUE

{
  "field": "id",
  "message": "Category item with same 'id' already exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Updating categories present in account by name

Report End Point:

{{baseURL}}/category/byname/{name}

HTTP Method: PUT

Description: Update categories present in your Enboarder account by name

Parameters:

Name

Description

name

Name of the category

Request body (required):

EXAMPLE VALUE:

{
"name": "Division",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

Sample Response:

Code

Body

200

EXAMPLE VALUE:

{
"name": "Division",
"id": "sadfegawfg",
"attr": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

409

EXAMPLE VALUE

{
  "field": "name",
  "message": "Category item with same 'name' already exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Deleting categories present in account by ID

Report End Point:

{{baseURL}}/category/byid/{id}

HTTP Method: DELETE

Description: Delete categories present in your Enboarder account by ID

Parameters:

Name

Description

id

Id of the c

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
  "name": "Division",
  "id": "sadfegawfg"
}

404

EXAMPLE VALUE

{
  "field": "id",
  "message": "Category item with 'id' does not exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "id",
  "message": "should have required property 'id'"
}

403

Forbidden

Deleting categories present in account by name

Report End Point:

{{baseURL}}/category/byname/{name}

HTTP Method: DELETE

Description: Delete categories present in your Enboarder account by name

Parameters:

Name

Description

name

Name of the category

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
  "name": "Division",
  "id": "sadfegawfg",
}

404

EXAMPLE VALUE

{
  "field": "name",
  "message": "Category item with 'name' does not exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Custom Field Endpoints

Base URL:

AU 🇦🇺 : https://api.syd.e1.enboarder.com/restapi/v1/settings

EU 🇪🇺 : https://api.fra.e1.enboarder.com/restapi/v1/settings

US 🇺🇸 : https://api.ore.e1.enboarder.com/restapi/v1/settings

CA 🇨🇦 : https://api.can.e1.enboarder.com/restapi/v1/settings

MODEL

Name

Type

id

string

name

string (unique)

type

string (f-shorttext/ f-longtext/ f-number/ f-date/ f-time/ f-picklist)

required

string (yes/no)

values

array (object) for picklist alone

Get a list of custom fields in your Enboarder account

Report End Point:

{{baseURL}}/customfield/all

HTTP Method: GET

Description: Get custom fields present in your Enboarder account

Parameters: None

Sample Response:

Code

Body

200

EXAMPLE VALUE:

[
{
"id": "sadfegawfg",
"name": "Division",
"type: "f-shorttext",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}
]

404

Forbidden

Create a new custom field

{{baseURL}}/customfield

HTTP Method: POST

Description: Create a custom field in your Enboarder account

Parameters: None

Request body (required):

EXAMPLE VALUE

{
"id": "sadfegawfg",
"name": "Division",
"type: "f-picklist",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

Sample Response:

Code

Body

201

EXAMPLE VALUE

{
"id": "sadfegawfg",
"name": "Division",
"type: "f-picklist",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

409

EXAMPLE VALUE

{
  "field": "name",
   "message": "Custom field item with same 'name' already exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Get custom field by ID

{{baseURL}}/customfield/byid/{id}

HTTP Method: GET

Description: Get a custom field in your Enboarder account by ID

Parameters:

Name

Description

id

Identifier of the custom field

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "sadfegawfg",
"name": "Division",
"type: "f-picklist",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

400

EXAMPLE VALUE

{
  "field": "id",
  "message": "Custom field item with 'id' does not exist"
}

403

Forbidden

Get custom field by name

{{baseURL}}/customfield/byname/{name}

HTTP Method: GET

Description: Get a custom field in your Enboarder account by name

Parameters:

Name

Description

name

Name of the custom field

Responses

Code

Body

200

EXAMPLE VALUE:

{
"name": "Division",
"id": "sadfegawfg",
"values": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

400

EXAMPLE VALUE

{
  "field": "name",
  "message": "Custom field item with 'name' does not exist"
}

403

Forbidden

Update custom field by ID

{{baseURL}}/customfield/byid/{id}

HTTP Method: PUT

Description: Update a custom field in your Enboarder account by ID

Parameters:

Name

Description

id

Id of the custom field

Request body (required):

EXAMPLE VALUE:

{
"name": "Division",
"values": [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "sadfegawfg",
"name": "Division",
"type: "f-picklist",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

404

EXAMPLE VALUE

{
  "field": "id",
  "message": "Custom field item with 'id' does not exists"
}

409

EXAMPLE VALUE

{
  "field": "id",
  "message": "Custom field item with same 'id' already exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Update custom field by name

{{baseURL}}/customfield/byname/{name}

HTTP Method: PUT

Description: Update a custom field in your Enboarder account by name

Parameters:

Name

Description

name

Name of the custom field

Request body (required):

EXAMPLE VALUE

{
"id": "sadfegawfg",
"name": "Division",
"type: "f-picklist",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
"id": "sadfegawfg",
"name": "Division",
"type: "f-picklist",
"required": "yes",
"values: [
{
"value": "Sales",
"key": "qCYTxeBLQp"
},
{
"value": "Marketing",
"key": "kWQZSkAUv"
}
]
}

409

EXAMPLE VALUE

{
  "field": "name",
  "message": "Custom field item with same 'name' already exists"
}

400

Example value

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Delete custom field by ID

{{baseURL}}/customfield/byid/{id}

HTTP Method: DELETE

Description: Delete a custom field in your Enboarder account by ID

Parameters:

Name

Description

id

Id of the custom field

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
  "name": "Division",
  "id": "sadfegawfg"
}

404

EXAMPLE VALUE

{
  "field": "id",
  "message": "Custom field item with 'id' does not exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "id",
  "message": "should have required property 'id'"
}

403

Forbidden

Delete custom field by name

{{baseURL}}/customfield/byname/{name}

HTTP Method: DELETE

Description: Delete a custom field in your Enboarder account by name

Parameters:

Name

Description

name

Name of the custom field

Sample Response:

Code

Body

200

EXAMPLE VALUE

{
  "name": "Division",
  "id": "sadfegawfg",
}

404

EXAMPLE VALUE

{
  "field": "name",
  "message": "Custom field item with 'name' does not exists"
}

400

EXAMPLE VALUE

{
  "errorType": "required",
  "field": "name",
  "message": "should have required property 'name'"
}

403

Forbidden

Got questions? Reach out to the team by clicking the '?' button at the top right of any Enboarder page. 😎

Did this answer your question?