Thanks to visit codestin.com
Credit goes to docs.timify.dev

API Reference
HomeLOGIN

Update custom fields

patch
https://api.timify.com/v1/customers/customfields/

Each custom field is a data field for every customer. For example: firstName, lastName etc. With this endpoint, you can create your own custom fields like customerNr.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
Codestin Search AppLoading…
Path Params
string
required

Id of the custom field

Query Params
string
enum

The "external" attribute specifies if the search query will use the external or TIMIFY ID. When "external" is set as 1, "customFieldId" is used as the "externalId", alternatively the "customFieldId" is the TIMIFY id.

Allowed:
Body Params
string
required

The label of the custom field.

string
required

Category id of the custom field.

string

External Id of the custom field.

string
enum
required

Type of the custom field. Select the input type of the data field. For example, "birthday" is type "DATE".

options
array of objects

This is only required if the type is "SELECT"
Options are an array of objects, with label and value attributes. Example:

  [
    { "label": "Male", "value": "m" },
    { "label": "Female", "value": "f" }
  ]
options
boolean
Defaults to false

This attribute adds the custom field to the unique composite index of the customer. This only applies to the customer data field and not the booking data field. This attribute needs to be used with caution. When the value is changed it triggers the recalculation of internal indices which identifies all the company's customers.

service_ids
array of strings

An array of service ids. It is only required if the custom field is associated with services.
Example: service_ids: ["id1", "id2"]
Only one of the parameters is required: service_ids or course_ids

service_ids
courses_id
array of strings

An array of course ids. It is only required if the custom field is associated with a course or courses. Example: ```
course_ids: ["id1","id2"]

 __Only one of the parameters is required: service_ids or course_ids__
courses_id
boolean

The attribute makes the field required by bookers in the booking process.

boolean

The attribute makes the field required by team members of the company in the booking process.

boolean

Activate the field to be visible for the team members of the company.

boolean

Activate the field to be visible for the bookers in the booking process. The parameter active need to be set to true

string

Description of the customfield.

specific_service_category_ids
array of strings

An array of specific service category ids Example: specific_service_category_ids: ["id1","id2"]

specific_service_category_ids
specific_course_category_ids
array of strings

An array of specific course category ids Example: specific_course_category_ids: ["id1","id2"]

specific_course_category_ids
integer

Index for ordering in the list of fields

boolean
deprecated

please use field_type instead.

A short explanation of the values:

  • "TRUE" - only the most recent entry for this custom field will be saved and shown in the apps.
  • "FALSE - all entries for this custom field will be saved and shown. This is useful when you want to keep a log of this information.
enum

this field replaces has_override
Type definitions: CUSTOMER: Custom field is associated to the customer and changes rarely. Examples are birthdate or address. BOOKING: Custom field associated with the appointment. This is information that change often or is relevant to an appoint. Examples are blood pressure or body weight
BOOKING is the default type.

Allowed:
float

Specifies the price for the custom field and is added to the cost of the appointment.

integer

Specifies the duration for the custom field and is added to the duration of the appointment.

integer
Headers
string
required

Id of the company

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
Codestin Search AppLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?