Create a customer

curl --request POST \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

import requests

url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": false,
  "response": {}
}

{
  "error": true,
  "errors": [
    "error message",
    "error message"
  ]
}

{
  "message": "Unauthorized"
}

{
  "message": "Request URL not found"
}

{
  "message": "Internal Server Error"
}

POST

customers

Create a customer

curl --request POST \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

import requests

url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": false,
  "response": {}
}

{
  "error": true,
  "errors": [
    "error message",
    "error message"
  ]
}

{
  "message": "Unauthorized"
}

{
  "message": "Request URL not found"
}

{
  "message": "Internal Server Error"
}

Body raw (json)

{
    "first_name", // optional | string | max:255
    "last_name", // optional | string | max:255
    "display_name", // optional | string | required, if first_name and last_name are not provided or empty and should be unique | max:255
    "email", // optional | string | email | max:255
    "phone", // optional | string | max:255 | description: should be valid phone number
    "notes", // optional | string | max:7500
    "has_different_billing_address", // optional | boolean | acceptable_values: true,false
    "status", // optional | string | acceptable_values: lead,opportunity,current customer,lost,other,inactive
    "company_name", // optional | string | max:255
    "alt_email", // optional | string | email | max:255
    "billing_address_1", // optional | string | max:1000
    "billing_address_2", // optional | string | max:1000
    "billing_city", // optional | string | max:255
    "billing_state", // optional | string | max:255
    "billing_zip_code", // optional | string | max:255
    "assigned_to", // nullable | integer | description: the id of user whom assigned the customer
    "secondary_email", // optional | string | email | max:255
    "secondary_phone", // optional | string | max:255 | description: should be valid phone number
    "service_address_1", // optional | string | max:255
    "service_address_2", // optional | string | max:255
    "service_address_city", // optional | string | max:255
    "service_address_state", // optional | string | max:255
    "service_address_zip_code", // optional | string | max:255
    "job_notes", // optional | string | max:4000
    "customfields": [ // optional | array | description: array of custom fleds
        {
            "id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
            "field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
            "value" // required | string | custom value
        },
        {
            "id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
            "field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
            "value" // required | string | custom value
        }
    ],
    "locations": [ // optional | array | description: array for creating customer location(s)
        {
            "object_type",  // required | string | description: indicate the location object type. Mostly customer
            "object_id",  // nullable | integer | description: indicate the location object id. Mostly customer id
            "title", // required | string | max_length:255
            "address_1", // nullable | string | max_length:255
            "address_2", // nullable | string | max_length:255
            "city", // nullable | string | max_length:255
            "state", // nullable | string | max_length:255
            "zip_code", // nullable | string | max_length:255
            "is_main_location" // optional | boolean | acceptable_values: true,false | description: indicate if the location is main. This will be shown in the page
        },
        {
            "object_type",  // required | string | description: indicate the location object type. Mostly customer
            "object_id",  // nullable | integer | description: indicate the location object id. Mostly customer id
            "title", // required | string | max_length:255
            "address_1", // nullable | string | max_length:255
            "address_2", // nullable | string | max_length:255
            "city", // nullable | string | max_length:255
            "state", // nullable | string | max_length:255
            "zip_code", // nullable | string | max_length:255
            "is_main_location" // optional | boolean | acceptable_values: true,false | description: indicate if the location is main. This will be shown in the page
        }
    ],
    "account_type", // optional | string |  acceptable_values: individual,company | description: indicate customer type | default individual
    "pipeline_status_id", // optional | integer | description: Existing pipeline status id
    "lead_source_id", // optional | integer | description: Existing lead source id
    "tags", // optional | array | description: array of existing customer tag ids
    "notify_self_assigned" // optional | nullable | boolean | description: when true, the assignee is notified even if they are the user making the request
}

Authorizations

x-api-key

string

header

required

Body

application/json

first_name

string

Maximum string length: 255

last_name

string

Maximum string length: 255

display_name

string

Required if first_name and last_name are not provided or empty and should be unique.

Maximum string length: 255

string<email>

Maximum string length: 255

phone

string

Should be valid phone number.

Maximum string length: 255

notes

string

Maximum string length: 7500

has_different_billing_address

boolean

status

enum<string>

Available options:

lead,

opportunity,

current customer,

lost,

other,

inactive

company_name

string

Maximum string length: 255

alt_email

string<email>

Maximum string length: 255

billing_address_1

string

Maximum string length: 1000

billing_address_2

string

Maximum string length: 1000

billing_city

string

Maximum string length: 255

billing_state

string

Maximum string length: 255

billing_zip_code

string

Maximum string length: 255

assigned_to

integer | null

The id of user whom assigned the customer.

secondary_email

string<email>

Maximum string length: 255

secondary_phone

string

Should be valid phone number.

Maximum string length: 255

service_address_1

string

Maximum string length: 255

service_address_2

string

Maximum string length: 255

service_address_city

string

Maximum string length: 255

service_address_state

string

Maximum string length: 255

service_address_zip_code

string

Maximum string length: 255

job_notes

string

Maximum string length: 4000

customfields

object[]

Array of custom fields.

Hide child attributes

customfields.value

string

required

Custom value.

customfields.id

integer | null

Required if field_instance_id is not set. Custom field id.

customfields.field_instance_id

integer | null

Required if id is not set. Custom field instance id.

locations

object[]

Array for creating customer location(s).

Hide child attributes

locations.object_type

string

required

Indicate the location object type. Mostly customer.

locations.title

string

required

Maximum string length: 255

locations.object_id

integer | null

Indicate the location object id. Mostly customer id.

locations.address_1

string | null

Maximum string length: 255

locations.address_2

string | null

Maximum string length: 255

locations.city

string | null

Maximum string length: 255

locations.state

string | null

Maximum string length: 255

locations.zip_code

string | null

Maximum string length: 255

locations.is_main_location

boolean

Indicate if the location is main. This will be shown in the page.

account_type

enum<string>

default:individual

Indicate customer type.

Available options:

individual,

company

pipeline_status_id

integer

Existing pipeline status id.

lead_source_id

integer

Existing lead source id.

Response

Created

error

boolean

false when the request succeeds.

Example:

false

response

object

The created record.

Get Started

Assets

Assets Category

Comments

Company Profile

Contracts

Customers

Custom Fields

Estimates

Invoices

Items

Jobs

Lead Source

Locations

Material Lists

Payments

Pipeline Status

Projects

Purchase Orders

Subtasks

Tags

Teams

Timesheets

Users

Vendors

Version

Create a customer

Authorizations

Body

Response