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

      Create client

      Creates new client

      post-api /clients/create

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

      Request

      Query Parameters:  
      api_key *  
      first_name *
      		 String
      last_name * 
      		 String
      email * String
      DOB String - (Y-m-d) format, *case-sensitive
      salutation String, *case-sensitive
      gender String, *case-sensitive
      phone String, *case-sensitive
      mobile String, *case-sensitive
      label String, (comma separated)
      mailing_country
      		 String, *case-sensitive
      mailing_county
      		 String, *case-sensitive
      mailing_city
      		 String, *case-sensitive
      mailing_street
      		 String, *case-sensitive
      mailing_postal
      		 String, *case-sensitive
      source
      		 String, *case-sensitive
      owner
      		 String, *case-sensitive
      avatar
      		 String, *case-sensitive
      is_active
      		 Int, 1 for active, 0 for inactive
      location_name
      		 String, *case-sensitive
      opt_in_email
      		 Int, 1 or 0. Default is 1
      opt_in_phone
      		 Int, 1 or 0. Default is 1
      opt_in_post
      		 Int, 1 or 0. Default is 1
      opt_in_sms
      		 Int, 1 or 0. Default is 1
      opt_in_newsletter
      		 Int, 1 or 0. Default is 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

      {
        "status": 1,
        "message": "Contact has been successfully created!",
        "contact_id": "{contact_id}"
      }