1. Knowledge Base
  2. API Documentation

[API Endpoint] Creating Client

Overview

This API endpoint allows you to make an insert of a client into the PabauCRM system by making a simple POST request.

Endpoint

POST https://crm.pabau.com/OAuth2/clients/create_client.php

Parameters

Below are a list of the attributes you can currently pass into Pabau.

Our API Endpoint expects six parameters:

  • api_key(string)

  • company(int)

  • section(string) - *must have value "contacts"

  • Fname(string) - First name of client, *parameter is case-sensitive

  • Lname(string) - Last name of client, *parameter is case-sensitive

  • Email(string) - Email of client, *parameter is case-sensitive

Optional parameters:

  • DOB(string) - (Y-m-d) format, *parameter is case-sensitive

  • Salutation(string) - *parameter is case-sensitive

  • Gender(string) - *parameter is case-sensitive

  • Phone(string) - *parameter is case-sensitive

  • Mobile(string) - *parameter is case-sensitive

  • MailingCountry(string) - *parameter is case-sensitive

  • MailingProvince(string) - *parameter is case-sensitive

  • MailingCity(string) - *parameter is case-sensitive

  • MailingStreet(string) - *parameter is case-sensitive

  • MailingPostal(string) - *parameter is case-sensitive

Custom Fields

You can also parse custom field data into the client. Follow this guide and then add the variable taken when editing the custom field into your POST.

Did