Create a User Identity Create a new user identity
Creates a new user identity .
Request
Specify the characteristics of the new user identity by including the corresponding parameters in the request body. Note that if you specify one or more of the user_identity_key
, email_address
, or phone_number
, each of these values must be unique within your workspace .
Request Body Parameters
Sample Request
cURL (bash) Go
Copy curl -X 'POST' \
'https://connect.getseam.com/user_identities/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ${API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"user_identity_key": "jean_doe",
"email_address": "jean@example.com",
"phone_number": "+15555550110",
"full_name": "Jean Doe"
}'
Copy userIdentity, uErr := client.UserIdentities.Create(context.Background(), & useridentities . UserIdentitiesCreateRequest {
UserIdentityKey: api.String( "jenny_lee" ),
EmailAddress: api.String( "jenny@example.com" ),
PhoneNumber: api.String( "+15555550111" ),
FullName: api.String( "Jenny Lee" ),
})
if uErr != nil {
return uErr
}
fmt.Println(userIdentity)
return nil
Response
Returns a user_identity
containing the following properties:
This response also includes a Boolean ok
status indicator.
Sample Response
JSON
Copy {
"user_identity" : {
"user_identity_id" : "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" ,
"user_identity_key" : "jean_doe" ,
"email_address" : "jean@example.com" ,
"phone_number" : "+15555550110" ,
"display_name" : "Jean Doe" ,
"full_name" : "Jean Doe" ,
"created_at" : "2024-01-11T05:37:50.264Z" ,
"workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
} ,
"ok" : true
}
Last updated 3 months ago