Create a new customer

Request

POST https://api.rezdy.com/v1/customers

Request body

The request body takes a complete Customer resource, containing the following writable properties:

{
    "aboutUs": "string",
    "addressLine": "string",
    "addressLine2": "string",
    "city": "string",
    "companyName": "string",
    "countryCode": "string",
    "dob": "date-time",
    "email": "string",
    "fax": "string",
    "firstName": "string",
    "gender": "string",
    "id": "int64",
    "lastName": "string",
    "marketing": "boolean",
    "middleName": "string",
    "mobile": "string",
    "name": "string",
    "newsletter": "boolean",
    "phone": "string",
    "postCode": "string",
    "preferredLanguage": "string",
    "skype": "string",
    "state": "string",
    "title": "string"
}

Properties

Name Type Description Additional
aboutUs string

How did you hear about us?

Optional
addressLine string

Address

Optional
addressLine2 string

Extended Address

Optional
city string

City/Town/Suburb

Optional
companyName string

Company name

Optional
countryCode string

2 letter ISO country code

Optional
dob date-time

Date of birth

Optional
email string

Email

Optional
fax string

Fax number

Optional
firstName string

First name

Optional
gender string

Gender: MALE or FEMALE

Possible values are:

  • MALE
  • FEMALE
Optional
id int64

Rezdy internal ID of the customer

Optional
lastName string

Customer Last Name

Optional
marketing boolean

Agree to receive marketing emails

Optional
middleName string

Middle name

Optional
mobile string

Mobile phone number

Optional
name string

Full name - generated from first/middle/last names

Optional
newsletter boolean

Subscribe to the newsletter

Optional
phone string

Preferred Phone number

Optional
postCode string

Postcode / ZIP

Optional
preferredLanguage string

Preferred language. Should be a 2 letter ISO country code

Optional
skype string

Skype alias

Optional
state string

State/County/Region

Optional
title string

Title

Possible values are:

  • MR
  • MS
  • MRS
  • MISS
Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

ResponseCustomer

Explore this API

apiKey Enter your API Key to try this call
body

new Customer should include at least a firstName or an Email

Request Content-Type
Response Content-Type
Try it out!