Skip to main content
PUT
Associate

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. - Partner specific API key provided by Birdeye for data exchange.

x-business-number
string

e.g. - Long Business Number.

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
fieldId
number
required

fieldId of the custom field.

fieldValue
string
required

Field Value of custom field and will only be visible if value is present.

businessNumber
number
required

Long Business Number.

Response

OK

id
number

fieldId of the custom field.

Example:

376

fieldName
string

Name of the custom field.

Example:

"colours"

type
string

Type of field.

Example:

"DROPDOWN_MULTI"

fieldValue
string

Associated Field Value of custom field .

Example:

"Green"

defaultValue
string

Default Value of custom field and will only be visible if value is present.

Example:

"Green"

isHidden
boolean

Whether the custom field will be hidden or not.

allBusinesses
boolean

Whether the custom field will be for all businesses or not.

filterable
boolean

Whether the custom field will be filterable or not.