REI Software

REI Software Help Library

Search for any help questions or topics.

Custom Value API

O
Orlando
Updated 3 years ago

Custom Value

 

GET/v1/custom-values/

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

Get all available custom values.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/custom-values/' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "customFields": [

    {

      "id": "ocQHyuzHvysMo5N5VsXc",

      "name": "Select",

      "fieldKey": "{{ custom_value.test }}",

      "value": "test"

    },

    {

      "id": "ocQHyuzHvysMo5N5VsXc",

      "name": "Select",

POST/v1/custom-values/

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

Create custom value.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

BODYraw

{

    "name": "Custom Field",

    "value": "Value"

}

 

 

Successful response

Example Request

curl --location --request POST 'https://rest.reisoftware.com/v1/custom-values/' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "name": "Custom Field",

    "value": "Value"

}'

Example Response

200 OK

BodyHeader(1)

{

  "id": "ocQHyuzHvysMo5N5VsXc",

  "name": "Select",

  "fieldKey": "{{ custom_value.test }}",

  "value": "test"

}

GET/v1/custom-values/:customValueId

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

Get custom value by id.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

customValueId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Value Id

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/custom-values/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

{

  "id": "ocQHyuzHvysMo5N5VsXc",

  "name": "Select",

  "fieldKey": "{{ custom_value.test }}",

  "value": "test"

}

PUT/v1/custom-values/:customValueId

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

Update custom value.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

customValueId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Value Id

BODYraw

{

    "name": "Custom Field",

    "value": "Value"

}

 

 

Successful response

Example Request

curl --location --request PUT 'https://rest.reisoftware.com/v1/custom-values/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "name": "Custom Field",

    "value": "Value"

}'

Example Response

200 OK

BodyHeader(1)

{

  "id": "ocQHyuzHvysMo5N5VsXc",

  "name": "Select",

  "fieldKey": "{{ custom_value.test }}",

  "value": "test"

}

DEL/v1/custom-values/:customValueId

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

Delete one of custom value.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

customValueId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Value Id

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/custom-values/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

""



😞 😐 😃