Skip to main content
Create Client

Create a new client record in your CRM

Geoff Mina avatar
Written by Geoff Mina
Updated over a year ago

Create a new client record in your Moxie CRM with optional contacts included in the payload.
โ€‹
Endpoint: /action/clients/create

Method: POST

Request Body (example):

{
"name": "",
"clientType": "Client",
"initials": "",
"address1": "",
"address2": "",
"city": "",
"locality": "",
"postal": "",
"country": "",
"website": "",
"phone": "",
"color": "",
"taxId": "",
"leadSource": "",
"archive": false,
"paymentTerms": {
"paymentDays": 0,
"latePaymentFee": 0.00,
"hourlyAmount": 0.00,
"whoPaysCardFees": "Client"
},
"payInstructions": "",
"hourlyAmount": 0.00,
"roundingIncrement": 0,
"currency": "USD",
"stripeClientId": "",
"notes": "",
"contacts":[
{
"firstName": "",
"lastName": "",
"role": "",
"phone": "",
"email": "",
"notes": "",
"defaultContact": false,
"invoiceContact": false,
"portalAccess": false
}
]
}

Properties that require further clarification:

  • name - Required - Business Name

  • clientType - Required - Either "Client" or "Prospect"

  • initials - Optional - 3-4 characters that will be used for client avatar and invoice number sequences

  • whoPaysCardFee - Optional - Valid values are: Client, Freelancer, Split - determines if Stripe credit card fees are added to the invoice at 2.99%, split and added to the invoice at 1.5%, or not passed through and absorbed by the "Freelancer" (you)

  • currency - Required - valid ISO 4217 currency code

  • stripeClientId - Optional - If integrated with Stripe, this would be the customer Id of the Stripe record found inside of the Stripe dashboard.

  • contacts - Optional - array of contact records to create and associate with this client.

    • defaultContact - will receive all notifications for the client

    • invoiceContact - will receive copies of all invoices and all invoice notifications

    • portalAccess - allowed to log into your client poral

Did this answer your question?