v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Person API

Add a person

post/companies/{company_key}/mobiledb/persons/

Path parameters

company_keystring required

<div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> Please note that the <b>"Try It"</b> feature to the right will send an actual API call to our system, which may result in a new person record being created.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

external_person_idstring

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.

custom_fieldsobject

List of custom field key/value pairs.

Response

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.

person_keystring

A unique Vibes-asigned alphanumeric identifier for each person record.

external_person_idstring

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.

custom_fieldsobject

list of custom field key/value pairs.

created_atstring

The date this person was created, in the ISO-8601 format.

updated_atstring

The date this person was last updated, in the ISO-8601 format.

urlstring