Skip to main content
PUT
/
v1
/
contacts
/
{id}
Update contact
curl --request PUT \
  --url https://api.shingleai.com/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "company": "Acme Corp",
  "jobTitle": "Software Engineer",
  "picture": "https://example.com/avatar.jpg",
  "notes": "Met at conference",
  "title": "Mr.",
  "name": "John Doe",
  "data": {}
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "jobTitle": "<string>",
    "picture": "<string>",
    "notes": "<string>",
    "title": "<string>",
    "name": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "data": {},
    "emails": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "label": "<string>",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "data": {}
      }
    ],
    "phoneNumbers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phoneNumber": "<string>",
        "countryCode": "<string>",
        "nationalNumber": "<string>",
        "label": "<string>",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "data": {}
      }
    ],
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "country": "<string>",
        "label": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "data": {}
      }
    ]
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication via Bearer token

Path Parameters

​
id
string<uuid>
required

Contact UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
​
firstName
string | null
Example:

"John"

​
lastName
string | null
Example:

"Doe"

​
company
string | null
Example:

"Acme Corp"

​
jobTitle
string | null
Example:

"Software Engineer"

​
picture
string | null
Example:

"https://example.com/avatar.jpg"

​
notes
string | null
Example:

"Met at conference"

​
title
string | null
Example:

"Mr."

​
name
string | null
Example:

"John Doe"

​
data
object

Response

Contact updated successfully

​
data
object
required
​
meta
object