Skip to main content
PATCH
/
orgs
/
{org_id}
/
contacts
/
{contact_id}
Update a Contact
curl --request PATCH \
  --url https://api.useinvent.com/orgs/{org_id}/contacts/{contact_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "blocked": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "blocked": true,
  "is_admin": true,
  "channels": [
    {
      "id": "<string>",
      "type": "internal",
      "user_id": "<string>",
      "avatar": "<string>",
      "name": "<string>",
      "username": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "country": "<string>",
      "agent": "<string>",
      "ip": "<string>",
      "language": "<string>",
      "platform_data": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "link": "<string>"
    }
  ],
  "segments": [
    {
      "id": "<string>",
      "name": "<string>",
      "contacts_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

Body

Schema for updating a contact

name
string | null

Name of the contact

Maximum string length: 512
blocked
boolean

Whether the contact is blocked

Response

200 - application/json

Schema for the contact

id
string
required
name
string | null
required
blocked
boolean
required
is_admin
boolean
required
channels
object[]
required
segments
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required