Update a company

patch

https://api.timify.com/v1/companies/{companyId}

Update the data of a company.
Only the fields you want to change need to be sent in the request body. All fields are optional. The companyId path parameter is the unique ID of the company assigned by TIMIFY.
To update the company phone number, send phone_country together with phone_number. Set phone_skip_validation to true to bypass phone number validation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

The id of the company

Body Params

name

string

The name of the company.

is_person

string

Indicates whether the company represents an individual person.

person_name

string

The name of the person, used when is_person is set.

description

string

A short description of the company.

info

string

Additional free-form information about the company.

business_sectors

array of strings

List of business sector identifiers associated with the company.

business_sectors

locale

string

The locale of the company (for example en-gb, de-de).

timezone

string

The IANA timezone of the company (for example Europe/London).

currency

string

The ISO 4217 currency code used by the company (for example EUR).

additional_currency

string | null

Display currency override for the company, as an ISO 4217 code (for example EUR). Send null to clear it and fall back to currency. Note: this is written as additional_currency here, but is returned as additionalCurrency (camelCase) by GET /companies.

address

object

The address of the company. To store addresses, our system relies on the Google Maps API. In cases where we receive a 'partial_match' response from Google, we save the matching items.

external_id

string

The external id of the company.
This parameter allows you to put your own companyId and compare the TIMIFY company data with your company database.

stripe_extra_fee_percentage

number

Extra Stripe fee percentage to apply on payments.

phone_country

string

The ISO country code of the phone number (for example DE).

phone_number

string

The phone number of the company.

phone_skip_validation

boolean

When true, the phone number will not be validated.

contact_email

string

The contact email of the company.

website

uri

The website URL of the company.

slug

string

The slug used to identify the company in public URLs.

hide_address_on_profile_page

boolean

When true, the company address will not be shown on the public profile page.

facebook_page_id

string

The Facebook page id linked to the company.

metadata

object

Dynamic object for extra data
Metadata is a holder for all extra information you want stored against the appointment

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Expected response to a valid request

400Bad Request

401Unauthorized

404Not found

500Internal Server Error