Create a Customer

Create a customer

curl --request POST \
  --url https://{your-workspace}.neetodesk.com/api/v1/public/customers \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "customer": {
    "emails": [
      "[email protected]",
      "[email protected]"
    ],
    "first_name": "John",
    "last_name": "Doe",
    "phones": [
      "+1234567890"
    ],
    "links": [
      "https://github.com/john"
    ],
    "language": "English",
    "time_zone": "Eastern Time (US & Canada)",
    "description": "VIP customer",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

{
  "notice_code": "<string>"
}

POST

customers

Create a customer

curl --request POST \
  --url https://{your-workspace}.neetodesk.com/api/v1/public/customers \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "customer": {
    "emails": [
      "[email protected]",
      "[email protected]"
    ],
    "first_name": "John",
    "last_name": "Doe",
    "phones": [
      "+1234567890"
    ],
    "links": [
      "https://github.com/john"
    ],
    "language": "English",
    "time_zone": "Eastern Time (US & Canada)",
    "description": "VIP customer",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

{
  "notice_code": "<string>"
}

Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json

customer

object

required

Hide child attributes

customer.emails

(string | object)[]

required

Array of email addresses. Can be provided as an array of strings or an array of objects with email and primary fields. The first email in the array is treated as primary if not specified.

Minimum array length: 1

Example:

"[email protected]"

Example:

["[email protected]", "[email protected]"]

customer.first_name

string

First name of the customer.

Example:

"John"

customer.last_name

string

Last name of the customer.

Example:

"Doe"

customer.phones

(string | object)[]

Array of phone numbers. Can be provided as an array of strings or an array of objects with phone and label fields.

Example:

"+1234567890"

customer.links

(string | object)[]

Array of links/URLs. Can be provided as an array of strings or an array of objects with url and label fields.

Example:

"https://github.com/john"

customer.language

string

Language preference for the customer.

Example:

"English"

customer.time_zone

string

Time zone for the customer.

Example:

"Eastern Time (US & Canada)"

customer.description

string

Description or notes about the customer.

Example:

"VIP customer"

customer.company_id

string<uuid>

ID of the company to associate the customer with.

Response

OK - Request succeeded

notice_code

string

Create a draft comment for a ticket Get ticket volume report

⌘I

Getting Started

Tickets API

Comments API

Customers API

Reports API

Team Members API

Headers

Body

Response