Skip to content

Contacts

Contacts represent journalists, editors, producers, and other individuals you interact with. Contacts can be linked to one or more outlets via the contact_outlet relationship.

create_contact

Create a new contact.

Parameters

ParameterTypeRequiredDescription
first_namestringYesFirst name
last_namestringYesLast name
emailstringNoPrimary email
phonestringNoPhone number
titlestringNoJob title
biostringNoBiography
is_freelancebooleanNoWhether the contact is freelance (default: false)
social_linksobjectNoKey-value pairs, e.g. { "twitter": "@handle", "linkedin": "url" }
preferencesobjectNoContact preferences as key-value pairs
notesstringNoFree-form notes

Example

json
{
  "name": "create_contact",
  "arguments": {
    "first_name": "Sarah",
    "last_name": "Chen",
    "email": "sarah.chen@techcrunch.com",
    "title": "Senior Reporter",
    "social_links": { "twitter": "@sarahchen" }
  }
}

get_contact

Get a contact by ID with their outlets and opportunities.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesContact ID

Example

json
{
  "name": "get_contact",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

list_contacts

List contacts with optional filters.

Parameters

ParameterTypeRequiredDescription
searchstringNoSearch by name or email
is_freelancebooleanNoFilter by freelance status
include_archivedbooleanNoInclude archived contacts (default: false)
limitnumberNoMax results (default: 50)
offsetnumberNoOffset for pagination (default: 0)

Example

json
{
  "name": "list_contacts",
  "arguments": {
    "search": "sarah",
    "limit": 10
  }
}

update_contact

Update contact fields.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesContact ID
first_namestringNoFirst name
last_namestringNoLast name
emailstringNoPrimary email
phonestringNoPhone number
titlestringNoJob title
biostringNoBiography
is_freelancebooleanNoFreelance status
social_linksobjectNoSocial link key-value pairs
preferencesobjectNoContact preferences
notesstringNoFree-form notes

Example

json
{
  "name": "update_contact",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Editor-in-Chief",
    "notes": "Promoted in March 2026"
  }
}

archive_contact

Soft-delete a contact.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesContact ID

Example

json
{
  "name": "archive_contact",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

restore_contact

Restore an archived contact.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesContact ID

Example

json
{
  "name": "restore_contact",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Associate a contact with an outlet. Tracks role, whether the association is current, and start date.

Parameters

ParameterTypeRequiredDescription
contact_idstring (UUID)YesContact ID
outlet_idstring (UUID)YesOutlet ID
rolestringNoTheir role at this outlet
is_primarybooleanNoCurrent (true) or historical (false). Default: true
start_datestringNoStart date (YYYY-MM-DD)

Example

json
{
  "name": "link_contact_outlet",
  "arguments": {
    "contact_id": "550e8400-e29b-41d4-a716-446655440000",
    "outlet_id": "660e8400-e29b-41d4-a716-446655440000",
    "role": "Senior Reporter",
    "start_date": "2024-01-15"
  }
}

End a contact's association with an outlet. Sets end_date to today and is_primary to false. The record is preserved for historical reference.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)Yescontact_outlet record ID

Example

json
{
  "name": "unlink_contact_outlet",
  "arguments": {
    "id": "770e8400-e29b-41d4-a716-446655440000"
  }
}