Create Contact

To create a contact, make a POST request to the following endpoint:

https://api.peach-in.com/v4/contacts

Request

Include your API key in the Authorization header of the request, as described in the Authorization section.

Response

A successful response to the create contact endpoint will return the contact object in the JSON format. The response will include various details about the contact, such as its ID, name, and any associated details.

POST https://api.peach-in.com/v4/contacts

Request Body

Name	Type	Description
address	String
lastName*	String	Contact's last name
firstName*	String	Contact's first name
phone	String	Contact's phone number
email*	String	Contact's email address
city	String
street	String
streetNumber	String
aptNumber	String
zipCode	String
groups	Array	Names of groups to add to the contact
customProperties	Object	object with contact's custom properties as set up in the system.

200: OK

{
    "contactBody": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "[e-mail]",
        "telephone": "123-456-7891",
        "address": "123 Main St",
        "city": "Anytown",
        "street": "Main St",
        "streetNumber": "123",
        "aptNumber": "Apt 4B",
        "zipCode": "12345",
        "accountId": "5e2U",
        "status": "external",
        "source": "CLIENT_API",
        "group_2579fdb1-f75e-4ca3-bd75-905ec11e7cbe": true,
        "group_3f5e0cd1-be97-4efa-a286-61b8ae8f5d9e": true
    },
    "contactResponse": "c75222a0-292d-11ee-9bb9-63a10e08ce0d",
    "contactId":"c75222a0-292d-11ee-9bb9-63a10e08ce0d",
    "failedCustomProperties": {
        "cb": "value should be boolean or string \"true\" or \"false\""
    }
}