FIfieldpulse
Customers

Create a customer

Changed on
post/customers

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers
  • Auth
    API key in header x-api-key

Request body

first_namestring
last_namestring
display_namestring

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

emailstring email
phonestring

Should be valid phone number.

notesstring
has_different_billing_addressboolean
status'lead' | 'opportunity' | 'current customer' | 'lost' | 'other' | 'inactive'
company_namestring
alt_emailstring email
billing_address_1string
billing_address_2string
billing_citystring
billing_statestring
billing_zip_codestring
assigned_tointeger nullable

The id of user whom assigned the customer.

secondary_emailstring email
secondary_phonestring

Should be valid phone number.

service_address_1string
service_address_2string
service_address_citystring
service_address_statestring
service_address_zip_codestring
job_notesstring
account_type'individual' | 'company'

Indicate customer type.

pipeline_status_idinteger

Existing pipeline status id.

lead_source_idinteger

Existing lead source id.

tagsinteger[]

Array of existing customer tag ids.

notify_self_assignedboolean nullable

When true, the assignee is notified even if they are the user making the request.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the success response with the status