Skip to content

Custom field Changes #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SambhavBirdeye wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Custom field Changes #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 82 additions & 23 deletions apiary.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4177,8 +4177,10 @@ Only required when when type is either "DROPDOWN_SINGLE" or "DROPDOWN_MULTI".
+ Body

{
"defaultValue": "Green",
"dropDownOptions": ["Blue", "Green", "Red"],
"defaultValue": "Green,Red",
"dropDownOptions": [{"value": "Blue"},
{"value": "Green"},
{"value": "Red"}],
"fieldDescription": "This custom field contains list of colours",
"fieldName": "colours",
"filterable": "false",
Expand All @@ -4195,10 +4197,21 @@ Only required when when type is either "DROPDOWN_SINGLE" or "DROPDOWN_MULTI".
{

"id": 376,
"accountId": 120893,
"businessId": 120893,
"fieldName": "colours",
"created": 1751480725861,
"updated": 1751480725861

"fieldValue": "Unassigned",
"type": "DROPDOWN_MULTI",
"defaultValue": "Green,Red",
"fieldDescription": "This custom field contains list of colours",
"created": 1763459383629,
"updated": 1763459383629,
"dropDownOptions": [
{ "id": 1130, "value": "Blue" },
{ "id": 1131, "value": "Green" },
{ "id": 1137, "value": "Red" }
],
"filterable": false
}

+ Response 400
Expand Down Expand Up @@ -4255,17 +4268,23 @@ Update custom Fields
+ Body

{
"defaultValue": "Green",
"dropDownOptions": ["Blue", "Green", "Red"],
"fieldDescription": "This custom field contains list of colours",
"filterable": "false",
"isHidden": "false"
}
"fieldName": "colors",
"type": "DROPDOWN_MULTI",
"defaultValue": "Blue",
"fieldDescription": "Updated colors ",
"filterable": true,
"applyDefaultValueToExisting": true,
"dropDownOptions": [
{ "id": 101, "value": "Blue" }, // existing option (has id)
{ "id": 102, "value": "Green" }, // existing option (has id)
{ "value": "Violet" }, // new option (no id)
{ "value": "Yellow" } // new option (no id)
]
}




+ Response 200
+ Response 200


+ Body
Expand Down Expand Up @@ -4306,23 +4325,42 @@ Get custom Fields

+ Attributes
+ id: 376 (number)- fieldId of the custom field.
+ accountId : 120893 (number)- Short accountId.
+ businessId : 120893 (number)- Short businessId.
+ fieldValue: Green (string)- Field Value of custom field and will only be visible if value is present.
+ fieldName: colours (string)- Name of the custom field.
+ type: DROPDOWN_MULTI (string)- Type of field.
+ defaultValue: Green (string)- Default Value of custom field and will only be visible if value is present.
+ fieldDescription: This custom field contains list of colours (string)-Description of custom field.
+ filterable: false (boolean)- Whether the custom field will be filterable or not.
+ dropDownOptions: Blue,Green,Red (array)- The list of options in custom field and will only be visible if value is present.

+ Body

{
"id": 376,
"accountId": 120893,
"businessId": 120893
"fieldName": "colours",
"fieldValue": "Green",
"type": "DROPDOWN_MULTI",
"defaultValue": "Greens",
"fieldDescription": "This custom field contains list of colours",
"filterable": false
"dropDownOptions": [
{
"id": 1130,
"value": "Green"
},
{
"id": 1131,
"value": "Blue"
},
{
"id": 1137,
"value": "Yellow"
}
],
"filterable": false
}


Expand Down Expand Up @@ -4385,6 +4423,12 @@ Get custom Fields List
+ Body

{
"page": 0,
"size": 20,
"totalCount": 2,
"totalPages": 1,
"customFields": [
{
"id": 376,
"fieldName": "colours",
"fieldValue": "Green",
Expand All @@ -4393,17 +4437,29 @@ Get custom Fields List
"fieldDescription": "This custom field contains list of colours",
"filterable": false,
"dropDownOptions": [
{
{ "id" : 111,
"value": "Blue"
},
{
},
{ "id" : 112,
"value": "Green"
},
{
"value": "Red"
{ "id" : 113,
"value": "Red"
}
]
},
{
"id": 5421,
"fieldName": "Account Exec",
"type": "TEXT",
"fieldDescription": "Sales owner",
"defaultValue": "Pending assignment",
"fieldValue": "Jane Doe",
"filterable": true,
"dropDownOptions": null
}
]
}


+ Response 406
Expand Down Expand Up @@ -4478,23 +4534,26 @@ Associate custom Fields

+ Attributes
+ id: 376 (number)- fieldId of the custom field.
+ accountId : 120893 (number)- Short accountId.
+ businessId : 120893 (number)- Short businessId.
+ fieldName: colours (string)- Name of the custom field.
+ type: DROPDOWN_MULTI (string)- Type of field.
+ fieldValue: Green (string)- Associated Field Value of custom field .
+ defaultValue: Green (string)- Default Value of custom field and will only be visible if value is present.
+ isHidden: false (boolean)- Whether the custom field will be hidden or not.
+ allBusinesses: false (boolean)- Whether the custom field will be for all businesses or not.
+ filterable: false (boolean)- Whether the custom field will be filterable or not.
+ fieldDescription: This custom field contains list of colours (string)-Description of custom field.

+ Body

{
"id": 376,
"accountId": 120893,
"businessId": 223344,
"fieldName": "colours",
"type": "DROPDOWN_MULTI",
"fieldValue": "Green",
"isHidden": false,
"allBusinesses": false,
"defaultValue": "Red",
"fieldDescription": "This custom field contains list of colours",
"filterable": false
}

Expand Down