Page tree
Skip to end of metadata
Go to start of metadata

Get /custom_fields

Provides the entire list of Custom Fields 

Returns the entire list of  Custom Fields .

There are 3 entities in SalesSeek which settings allow adding custom fields, apart from the default ones, these are:

  • Individuals
  • Organizations
  • Deals

A custom field is intented to provide extra information about the entity, has a data type and may be configured with a default value.

Request URL

https://{client_id}.salesseek.net/api/custom_fields?filter=view%3Dindividuals  

Response Type

Response content type: JSON Array[CustomFields]

ModelExample of Response

Array[CustomFields]

 

Custom Field {

id (string): unique identifier for this custom field

name (string): Name of the custom field to be shown,

value (Value): possible values on the field (including the default one),

view (Enum): the type of entity this custom field applies to, can be: individuals, organizations or deals

type (Enum): type of custom field, depending on the type may have addiitional details. The available options are:

    • text: inline string
    • checkbox: option of true or false
    • currency: dropdown with the available currencies
    • date: date picket
    • dropDown: Enum or list of restricted options to select 1
    • individual: Reference to an individual from SalesSeek system
    • number: number format (double)
    • organization: Reference to an organization from SalesSeek system
    • paragraph: Long text, muti-line
    • url: clickeable link
    • urlImage: url field to be shown as an image

}

value (JSON): {

default (string): The content of the default value for the associated Custom Field

options (Array[Options]): Only if the type is Dropdown, ordered list of possible values

}

 

[
  0:{
    id: "9847a331c89",
	name: "Description",
	type: "text",
	value: {
		default:"",
	}
	view: "individuals"
  },
  1: {
	id: "30b7184ad42bfa",
	name: "Is_Active",
	type: "checkbox",
	value: {
		default: "true"
	},
	view: "individuals"
  },
  2:{
	id: "7b94a68b1fcb7",
	name: "Region",
	type: "dropDown",
	value: {
		default: "309b89352",
		options: [
			0: {
				id: "309b89352",
				value: "South"
			},
			1: {
				id: "c0e1107fa8b",
				value: "North"
			}
		]
	}
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
filterInY

type of entity to request custom fields

int
responseOut-Resulting list of Custom FieldsArray[Custom Fields]

 

 


 

 

POST /custom_fields

Creates a new Custom Fields 

Creates a new Custom Fields and Returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/custom_fields

Request Body
{
	name: "Region"
	type: "dropDown"
	value: {
		default: "0"
		options: [
			0: {
				id: ""
				value: "South"
			}
			1: {
				id: ""
				value: "North"
			}
		]
	}
}

 

Response Type

Response content type: JSON XXXXXXXXXXXXXX

ModelExample of Response

Custom Field {

id (string): unique identifier for this custom field

name (string): Name of the custom field to be shown,

value (Value): possible values on the field (including the default one),

view (Enum): the type of entity this custom field applies to, can be: individuals, organizations or deals

type (Enum): type of custom field, depending on the type may have addiitional details. The available options are:

    • text: inline string
    • checkbox: option of true or false
    • currency: dropdown with the available currencies
    • date: date picket
    • dropDown: Enum or list of restricted options to select 1
    • individual: Reference to an individual from SalesSeek system
    • number: number format (double)
    • organization: Reference to an organization from SalesSeek system
    • paragraph: Long text, muti-line
    • url: clickeable link
    • urlImage: url field to be shown as an image

}

value (JSON): {

default (string): The content of the default value for the associated Custom Field

options (Array[Options]): Only if the type is Dropdown, ordered list of possible values

}

{
	id: "7b94a68b1fcb7",
	name: "Region",
	type: "dropDown",
	value: {
		default: "309b89352",
		options: [
			0: {
				id: "309b89352",
				value: "South"
			},
			1: {
				id: "c0e1107fa8b",
				value: "North"
			}
		]
	}
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The Custom Fields created after the successful requestJSON

 


 

DELETE /custom_fields/{custom_f_id}

Deletes the selected Custom Field

Removes the selected Custom Field from SalesSeek system

Request URL

https://{client_id}.salesseek.net/api/custom_fields/88374738

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Custom Fields_idInYThe id of Custom Field to be deletedArray[JSON]

 

 


 

 

PATCH /custom_fields/{custom_fields_id}

Update a specific Custom Fields by its ID

Updates a Custom Fields by its {custom_fields_id} and Returns the resulting element. The fields updated are just the ones passed on the request body

 

Request URL

https://{client_id}.salesseek.net/api/custom_fields/69d1fbe62  

 

Request Body
{
  	name: "Is_Still_Active"
	type: "checkbox"
	value: {
		default: "false"
	}
	view: "individuals"
}

 

Response Type

Response content type: JSON CustomField

ModelExample of Response

Custom Field {

id (string): unique identifier for this custom field

name (string): Name of the custom field to be shown,

value (Value): possible values on the field (including the default one),

view (Enum): the type of entity this custom field applies to, can be: individuals, organizations or deals

type (Enum): type of custom field, depending on the type may have addiitional details. The available options are:

    • text: inline string
    • checkbox: option of true or false
    • currency: dropdown with the available currencies
    • date: date picket
    • dropDown: Enum or list of restricted options to select 1
    • individual: Reference to an individual from SalesSeek system
    • number: number format (double)
    • organization: Reference to an organization from SalesSeek system
    • paragraph: Long text, muti-line
    • url: clickeable link
    • urlImage: url field to be shown as an image

}

value (JSON): {

default (string): The content of the default value for the associated Custom Field

options (Array[Options]): Only if the type is Dropdown, ordered list of possible values

}

{
	name: "Is_Still_Active"
	type: "checkbox"
	value: {
		default: "false"
	}
	view: "individuals"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Custom Fields_idInYThe id of the Custom Field to be updatedstring
 Custom Fields InYThe subset of the Custom Fields to be updatedJSON
 response OutThe Custom Fields after the successful updateJSON
  • No labels