Skip to main content
POST
Create or get a User

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Path Parameters

id
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Body

application/json
handle
string
required
Required string length: 1 - 512
platform
enum<string>
required
Available options:
sms,
email,
whatsapp,
whatsapp_business,
imessage,
telegram

Response

The existing User after authoritative classification and any required repair.

createdAt
string<date-time>
required

When Photon first persisted this resource.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
details
object
required
handle
string
required
Minimum string length: 1
id
string
required
Pattern: ^pho_usr_[0-7][0-9a-hjkmnp-tv-z]{25}$
kind
string
required
Minimum string length: 1
metadata
object
required
platform
enum<string>
required
Available options:
sms,
email,
whatsapp,
whatsapp_business,
imessage,
telegram
Allowed value: "sms"
projectId
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$
updatedAt
string<date-time>
required

When Photon last persisted a change to this resource's public state.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$