Skip to main content
PATCH
/
v2
/
internal-contacts
/
{internal_contact_id}
Update an Internal Contact
curl --request PATCH \
  --url https://api.example.com/v2/internal-contacts/{internal_contact_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "given_name": "<string>",
  "family_name": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "job_title": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "email": "<string>",
  "given_name": "<string>",
  "family_name": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "job_title": "<string>",
  "object": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

internal_contact_id
string
required

Body

application/json

Request body for updating an internal contact's fields.

email
string | null

The internal contact's email address.

given_name
string | null

The internal contact's given name.

family_name
string | null

The internal contact's family name.

name
string | null

The internal contact's full name, if no given/family name.

phone
string | null

The internal contact's phone number.

job_title
string | null

The internal contact's job title.

Response

Successful Response

An internal contact (CSM, AM, etc.) at the organization level.

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
email
string
required

The internal contact's email address.

given_name
string | null
required

The internal contact's given name.

family_name
string | null
required

The internal contact's family name.

name
string | null
required

The internal contact's full name, if no given/family name.

phone
string<phone> | null
required

A phone number in E.164 format

job_title
string | null
required

The internal contact's job title.

object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.