Create a user POST app.animate.io/api/v1/users
Required Parameters
Key Value
auth_token Your platform's auth token
display_name The user's display name
email The user's email address
role_id The user's role_id
Optional Parameters
Key Value
phone_number The user's phone_number
address The user's address
avatar The user's avatar. Should be a link to a photo URL.
field_nlynyhfvamztk3dvvyfyew
Admin Tags
The field value for "Admin Tags"
field_j1n4ywekfhxgdwmmscw0gq
Categories
The field value for "Categories"
field_iu0eodobrhgowrrx5ryzfg
Lottie File
The field value for "Lottie File"
field_hefde2pjxitdj76qkbnrw
File Type
The field value for "File Type"
field_6qzwdgqtsuhne0oqrogg
Not for sale?
The field value for "Not for sale?"
field_dklzsrbex5w1ewfnu2gncq
Description
The field value for "Description"
field_fkqjbe6z7yn7j5jyuakg
Display Name
The field value for "Display Name"
field_1hnhzbusdl54wk6wzb8ooq
Email
The field value for "Email"
field_4wyuya3lktau48rbfjb6ua
Profile Photo
The field value for "Profile Photo"
field_4jrusvbtbfqvvi028bs4qq
Title
The field value for "Title"
field_exxh85wlep8bpbqiyzgmkg
Price
The field value for "Price"
field_fswhcu6jdhgbk4bfxkczg
File Name (For listing display purposes)
The field value for "File Name (For listing display purposes)"
field_tmmuajl4xigzsxaa9hscxg
File Size (for listing display purposes)
The field value for "File Size (for listing display purposes)"
field_3j3lxkaknauznofwcirtw
Duration
The field value for "Duration"
Get a user GET app.animate.io/api/v1/users/:id
Generate authentication link GET app.animate.io/api/v1/generate_auth_link
Required Parameters for Get User
Key Value
auth_token Your platform's auth token
Required Parameters for Generate Auth Link
Key Value
auth_token Your platform's auth token
email The user's email address
Optional Parameters for Generate Auth Link
Key Value
user_id Alternative to email: The user's ID (slug). Either email or user_id must be provided.
remember_me Set to '1' to keep the user logged in after browser closure. Defaults to '0'.
Response for Generate Auth Link
{
  "user_id": "user-slug-123",
  "email": "user@example.com",
  "auth_link": "https://your-platform.com/user/magic_link?user[email]=user@example.com&user[token]=abc123&user[remember_me]=0",
  "expires_at": "2023-06-30T12:00:00Z"
}

The authentication link can be sent to users via email or other communication channels. When clicked, it will automatically log the user in without requiring a password. The link is valid for the duration specified by your Devise configuration (typically 6 hours) and can only be used once.

Note: Magic links must be enabled for your organization for this endpoint to work.

Update a user POST app.animate.io/api/v1/users/:id
Required Parameters
Key Value
auth_token Your platform's auth token
id The Tangram ID of the user
Optional Parameters
Key Value
display_name The user's display name
email The user's email address
phone_number The user's phone_number
address The user's address
field_nlynyhfvamztk3dvvyfyew
Admin Tags
The field value for "Admin Tags"
field_j1n4ywekfhxgdwmmscw0gq
Categories
The field value for "Categories"
field_iu0eodobrhgowrrx5ryzfg
Lottie File
The field value for "Lottie File"
field_hefde2pjxitdj76qkbnrw
File Type
The field value for "File Type"
field_6qzwdgqtsuhne0oqrogg
Not for sale?
The field value for "Not for sale?"
field_dklzsrbex5w1ewfnu2gncq
Description
The field value for "Description"
field_fkqjbe6z7yn7j5jyuakg
Display Name
The field value for "Display Name"
field_1hnhzbusdl54wk6wzb8ooq
Email
The field value for "Email"
field_4wyuya3lktau48rbfjb6ua
Profile Photo
The field value for "Profile Photo"
field_4jrusvbtbfqvvi028bs4qq
Title
The field value for "Title"
field_exxh85wlep8bpbqiyzgmkg
Price
The field value for "Price"
field_fswhcu6jdhgbk4bfxkczg
File Name (For listing display purposes)
The field value for "File Name (For listing display purposes)"
field_tmmuajl4xigzsxaa9hscxg
File Size (for listing display purposes)
The field value for "File Size (for listing display purposes)"
field_3j3lxkaknauznofwcirtw
Duration
The field value for "Duration"
Delete a user DELETE app.animate.io/api/v1/users/:id
Required Parameters
Key Value
auth_token Your platform's auth token