Skip to main content
Users

Create or Update User

Create or update a User with profile data

PUT
/
v3
/
users
/
{identifier}

Authentication Parameters

X-ENGAGESPOT-API-KEY
string
header
required

X-ENGAGESPOT-API-SECRET
string
header
required

Path Parameters

identifier
string
required

Unique identifier of the user

Body Parameters

email
string

Email address of the user

phoneNumber
string

Phone number of the user

key
string

Any additional key-value pair to be attached to this user's profile

import { EngagespotClient } from '@engagespot/node';

const client = EngagespotClient({
  apiKey: 'ENGAGESPOT_API_KEY',
  apiSecret: 'ENGAGESPOT_API_SECRET',
});

client.createOrUpdateUser('identifier', {
  email: 'xxx@xxx.com',
  phoneNumber: '+xxxxxxxxx',
});
{
  "identifier": "550e8400-e29b-41d4",
  "phoneNumber": "+10123456789",
  "email": "abc@xyz.com"
}