---
title: "Add a person"
method: POST
path: "/companies/{company_key}/mobiledb/persons/"
tags: ["Person API"]
---

# Add a person

`POST /companies/{company_key}/mobiledb/persons/`

## Path parameters

- `company_key` string, required

## Headers

- `X-API-Version` string
- `Content-Type` string, required

## Request body

- PersonRequest
  - `external_person_id` string — A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Max 128 characters.
  - `mobile_phone` object — Object representation of a person's mobile phone. A person can have only one active mobile phone at a time.
    - `mdn` string — Mobile Directory Number. The dialable phone number associated with the phone.
    - `carrier_code` string — The cellular carrier associated with this mobile number.
  - `custom_fields` object — List of custom field key/value pairs.

## Response `200`

Successful response. An existing person record already exists with the same MDN. The record will be updated with the added information, and any unspecified data fields on the record will remain unchanged.

- PersonResponse
  - `person_key` string — A unique Vibes-asigned alphanumeric identifier for each person record.
  - `external_person_id` string — A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Max 128 characters.
  - `mobile_phone` object — Object representation of a person's mobile phone. A person can have only one active mobile phone at a time.
    - `mdn` string — Mobile Directory Number. The dialable phone number associated with the phone.
    - `carrier_code` string — The cellular carrier associated with this mobile number.
  - `custom_fields` object — list of custom field key/value pairs.
  - `created_at` string — The date this person was created, in the ISO-8601 format.
  - `updated_at` string — The date this person was last updated, in the ISO-8601 format.
  - `url` string

## Other responses

- `201` — A person record has been created.
- `409` — Conflict error. Generally, this occurs if you are attempting to create a person record with an MDN that is already associted with another person record.
- `422` — The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.

---

[API](https://skmtc.net/vibes/apis/vibes-platform-api.md) · [All operations](https://skmtc.net/vibes/apis/vibes-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vibes/vibes-platform-api/revisions/2d5797ce1b84/schema)