Custom Value

Estimated reading: 5 minutes 22 views

GET /v1/custom-values/

				
					https://rest.gohighlevel.com/v1/custom-values/

Get all available custom values.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

Token

<token>

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/custom-values/' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "customFields": [
    {
      "id": "ocQHyuzHvysMo5N5VsXc",
      "name": "Select",
      "fieldKey": "{{ custom_value.test }}",
      "value": "test"
    },
    {
      "id": "ocQHyuzHvysMo5N5VsXc",
      "name": "Select",
      "fieldKey": "{{ custom_value.test }}",
      "value": "test"
    }
  ]
}

POST /v1/custom-values/

				
					https://rest.gohighlevel.com/v1/custom-values/

Create custom value.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

BODY raw (json)

				
					{
    "name": "Custom Field",
    "value": "Value"
}

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/custom-values/' \
--header 'Authorization: Bearer <token>' \
--data '{
    "name": "Custom Field",
    "value": "Value"
}'

EXAMPLE RESPONSE (json)

				
					{
  "id": "ocQHyuzHvysMo5N5VsXc",
  "name": "Select",
  "fieldKey": "{{ custom_value.test }}",
  "value": "test"
}

GET /v1/custom-values/:customValueId

				
					https://rest.gohighlevel.com/v1/custom-values/:customValueId

Get custom value by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

customValueId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Value Id

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/custom-values/ocQHyuzHvysMo5N5VsXc' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "id": "ocQHyuzHvysMo5N5VsXc",
  "name": "Select",
  "fieldKey": "{{ custom_value.test }}",
  "value": "test"
}

PUT /v1/custom-values/:customValueId

				
					https://rest.gohighlevel.com/v1/custom-values/:customValueId

Update custom value.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

customValueId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Value Id

BODY raw (json)

				
					{
    "name": "Custom Field",
    "value": "Value"
}

EXAMPLE REQUEST (curl)

				
					curl --location --request PUT 'https://rest.gohighlevel.com/v1/custom-values/ocQHyuzHvysMo5N5VsXc' \
--header 'Authorization: Bearer <token>' \
--data '{
    "name": "Custom Field",
    "value": "Value"
}'

EXAMPLE RESPONSE (json)

				
					{
  "id": "ocQHyuzHvysMo5N5VsXc",
  "name": "Select",
  "fieldKey": "{{ custom_value.test }}",
  "value": "test"
}

DELETE /v1/custom-values/:customValueId

				
					https://rest.gohighlevel.com/v1/custom-values/:customValueId

Delete one of custom value.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

customValueId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Value Id

EXAMPLE REQUEST(curl)

				
					curl --location --request DELETE 'https://rest.gohighlevel.com/v1/custom-values/ocQHyuzHvysMo5N5VsXc' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

""

Docly

Did You Know?

Custom Value

GET /v1/custom-values/

Get all available custom values.

AUTHORIZATION Bearer Token

Token

EXAMPLE REQUEST (curl)

EXAMPLE RESPONSE (json)

POST /v1/custom-values/

Create custom value.

AUTHORIZATION Bearer Token

Token

HEADERS

Content-Type

BODY raw (json)

EXAMPLE REQUEST (curl)

EXAMPLE RESPONSE (json)

GET /v1/custom-values/:customValueId

Get custom value by id.

AUTHORIZATION Bearer Token

Token

PATH VARIABLES

customValueId

EXAMPLE REQUEST (curl)

EXAMPLE RESPONSE (json)

PUT /v1/custom-values/:customValueId

Update custom value.

AUTHORIZATION Bearer Token

Token

HEADERS

Content-Type

PATH VARIABLES

customValueId

BODY raw (json)

EXAMPLE REQUEST (curl)

EXAMPLE RESPONSE (json)

DELETE /v1/custom-values/:customValueId

Delete one of custom value.

AUTHORIZATION Bearer Token

customValueId

EXAMPLE REQUEST(curl)

EXAMPLE RESPONSE (json)

Leave a Comment Cancel reply

Custom Value

CONTENTS