Clients
      Back to home
      1. APIs
      2. API Reference
      3. Clients

      Update client

      Helps you to easier update your clients

      post-api /clients/{contact_id}/update

      https://api.oauth.pabau.com/{api_key}/clients/{contact_id}/update

       

      Request

      Query Parameters:  
      api_key * API Key
      required
      contact_id* System ID of the client
      int
      required
      first_name 
      		 The first name of client
      string
      last_name 
      		 The last name of client
      string
      email The email of client
      string
      DOB The date of birth
      string
      (Y-m-d) format
      case sensitive
      salutation The salutation of the client
      string
      case sensitive
      gender The gender (eg. Male, Female, Other)
      string
      case sensitive
      phone The phone number
      string
      case sensitive
      mobile The mobile number of client
      string
      case sensitive
      label The client label
      string (comma seperated)
      case sensitive
      mailing_country
      		 The country of the client
      string
      case sensitive
      mailing_county
      		 The county or state of the client
      string
      case sensitive
      mailing_city
      		 The city/town of the client
      string
      case sensitive
      mailing_street
      		 The street of the client
      string
      case sensitive
      mailing_postal
      		 The postcode/zip of the client
      string
      case sensitive
      source
      		 The marketing source
      string
      case sensitive
      owner
      		 The full name of the client owner (usually who created the client)
      string
      case sensitive
      avatar
      		 The URL of photo avatar
      string
      case sensitive
      is_active
      		 Is the client active or not (1 or 0)
      int
      default: 1
      location_name
      		 The full name of the location (usually where the client most visits)
      string
      case sensitive
      opt_in_email
      		 Did the client opt into email (1 or 0)
      int
      default: 1
      opt_in_phone
      		 Did the client opt into email (1 or 0)
      int
      default: 1
      opt_in_post
      		 Did the client opt into post (1 or 0)
      int
      default: 1
      opt_in_sms
      		 Did the client opt into sms (1 or 0)
      int
      default: 1
      opt_in_newsletter
      		 Did the client opt into newsletters (1 or 0)
      int
      default: 1
      custom_field_name

      Name of the custom field. The following rules apply:
      1.Spaces Conversion: If the custom field name contains spaces, they should be replaced with underscores (_). For example, a field named "Custom Field Name" should be represented as "Custom_Field_Name".

      2. Names Without Spaces:  Field names that do not contain spaces should remain as they are, without modification.

      3.Batch Updated Supported: Multiple custom fields can be updated at the same time. To update multiple fields, specify each field name in the request with the respective value. The API will process and update each specified custom field accordingly.

       

      Response sample

      application/json

      {
        "success": true,
        "message": "Contact updated successfully."
      }