API Reference

Update person by person_key

put
https://public-api.vibescm.com/companies//mobiledb/persons/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request

Please note that you cannot edit the person_id, timezone_source, created_at, or updated_at fields; any values included in the request will be ignored. You can remove the mobile_phone value if you specify the value as null. If an MDN is specified with a changed, non-null value, an HTTP 409 – Conflict Error will be returned.

Path Params
string
required
string
required
Important: If you are entering a real person_key, please note that using the "Try It" feature on the righthand console will send an actual API call to our system. This may result in a person record being updated.
Body Params
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.

custom_fields
object

List of custom field key/value pairs.

Headers
string
Defaults to 1
Responses

201

Person record has been updated.

409

Conflict error. This may occur if you are attempting to update an MDN. Note that you cannot update an MDN on an existing person record, but you may remove an MDN by setting the value to null.

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.

Updated 9 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago