Peach Developer API Docs
  • Iframe Integration
  • Payment Webhook
  • Stripe integration
  • API Reference
    • Authentication
    • Campaigns
      • Get Campiagn
      • Get Campaign stats
    • Payments
      • Create Payment
      • Update Payment
    • Transactions
      • Get Transactions
    • Contacts
      • Create Contact
      • Get Contact
      • Delete Contact
      • Update Contact
    • Interactions
      • Create Note
    • Interactions
    • Marketing Campaigns
    • Users
    • Imports
Powered by GitBook
On this page
  1. API Reference
  2. Contacts

Update Contact

PreviousDelete ContactNextInteractions

Last updated 1 month ago

To update a contact, make a PUT request to the following endpoint:

https://api.peach-in.com/v4/updateContact/{contactId}

Request

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

Response

A successful response to update 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.

PUT https://api.peach-in.com/v4/updateContact{contactId}

Replace the {contactId} with the current contactId

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

removeGroups

Array

Names of groups to remove from the contact

customProperties

Object

object with contact's custom properties as set up in the system.

{
  "success": true,
  "message": "contact updated",
  "contact": {
{
    "contactBody": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "johndoe1@example.com",
        "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
    }
}
Authorization