Skip to main content
POST
/
v2
/
internal-contacts
Create an Internal Contact
curl --request POST \
  --url https://api.example.com/v2/internal-contacts \
  --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>",
  "partner_id": "<string>",
  "remote_id": "<string>",
  "internal_contact": {
    "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>"
  },
  "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.

Body

application/json

Request body for creating an internal contact and recording their role.

​
email
string
required

The internal contact's email address.

Minimum string length: 1
​
internal_role
enum<string>
required
Available options:
account_manager,
account_executive,
csm,
lead,
co_lead,
practice_lead
​
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 InternalContact assigned to a Partner with a specific role.

partner_id is null for "floating" assignments — contacts whose role is declared at the organization level but who have not yet been attached to a specific partner.

​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
id
string
required
​
internal_role
enum<string>
required

The role this internal contact holds for this partner.

Available options:
account_manager,
account_executive,
csm,
lead,
co_lead,
practice_lead
​
partner_id
string | null
required
​
remote_id
string | null
required

Third-party sync identifier for upsert deduplication.

​
internal_contact
object
required

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

​
object
string
required
read-only

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