---
title: "Create a contact"
method: POST
path: "/contacts"
tags: ["Contacts"]
---

# Create a contact

`POST /contacts`

## Request

- Base URL: `https://www.sociahive.com/api/v1`
- URL: `https://www.sociahive.com/api/v1/contacts`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `/api/oauth/authorize`, token URL `/api/oauth/token`, scopes: `contacts:write`)

## Request body

- object
  - `platform` 'instagram' | 'messenger' | 'whatsapp' | 'linkedin' | 'twitter' | 'tiktok' | 'telegram' | 'threads' | 'youtube' | 'bluesky' | 'pinterest' | 'facebook', required: Connected-account platform identifier
  - `platform_user_id` string, required
  - `first_name` string
  - `last_name` string
  - `email` string, email
  - `phone` string

## Response `201`

Contact created

- ContactEnvelope: Single-contact envelope — `{ data: <contact> }`.
  - `data` Contact, required
    - `_id` string, required: MongoDB ObjectId (24-character hex string)
    - `owner_user_id` string, required
    - `platform_identities` object[], required
      - `platform` string, required: Platform id. Known values: `instagram`, `messenger`, `whatsapp`, `linkedin`, `twitter`, `tiktok`, `telegram`, `threads`, `youtube`, `bluesky`, `pinterest`, `facebook`, `discord`, `mastodon`, `lemmy`, `devto`, `hashnode`, `wordpress`, `listmonk`, `slack`, `tumblr`, `dribbble`, `twitch`, `kick`. Treat any other value as unknown, never as an error.
      - `platform_user_id` string, required
      - `username` string
    - `display_name` string
    - `email` string
    - `phone` string
    - `avatar_url` string
    - `status` string, required
    - `source` string, required
    - `tags` string[], required
    - `notes` string
    - `interaction_count` number
    - `first_interaction_at` string, date-time
    - `last_active_at` string, date-time
    - `created_at` string, date-time, required
    - `updated_at` string, date-time

## Other responses

- `400`: Bad request — invalid parameters
- `401`: Authentication required — provide X-API-Key or Bearer token
- `403`: Insufficient scope for this operation
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/sociahive/apis/sociahive-api.md) · [All operations](https://skmtc.dev/sociahive/apis/sociahive-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sociahive/apis/sociahive-api/revisions/791b8548d288?raw)