| Create a user | POST | app.animate.io/api/v1/users |
| Key | Value |
|---|---|
| auth_token | Your platform's auth token |
| display_name | The user's display name |
| The user's email address | |
| role_id | The user's role_id |
| 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_nlynyhfvamztk3dvvyfyewAdmin Tags |
The field value for "Admin Tags" |
field_j1n4ywekfhxgdwmmscw0gqCategories |
The field value for "Categories" |
field_iu0eodobrhgowrrx5ryzfgLottie File |
The field value for "Lottie File" |
field_hefde2pjxitdj76qkbnrwFile Type |
The field value for "File Type" |
field_6qzwdgqtsuhne0oqroggNot for sale? |
The field value for "Not for sale?" |
field_dklzsrbex5w1ewfnu2gncqDescription |
The field value for "Description" |
field_fkqjbe6z7yn7j5jyuakgDisplay Name |
The field value for "Display Name" |
field_1hnhzbusdl54wk6wzb8ooq |
The field value for "Email" |
field_4wyuya3lktau48rbfjb6uaProfile Photo |
The field value for "Profile Photo" |
field_4jrusvbtbfqvvi028bs4qqTitle |
The field value for "Title" |
field_exxh85wlep8bpbqiyzgmkgPrice |
The field value for "Price" |
field_fswhcu6jdhgbk4bfxkczgFile Name (For listing display purposes) |
The field value for "File Name (For listing display purposes)" |
field_tmmuajl4xigzsxaa9hscxgFile Size (for listing display purposes) |
The field value for "File Size (for listing display purposes)" |
field_3j3lxkaknauznofwcirtwDuration |
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 |
| Key | Value |
|---|---|
| auth_token | Your platform's auth token |
| Key | Value |
|---|---|
| auth_token | Your platform's auth token |
| The user's email address |
| 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'. |
{
"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 |
| Key | Value |
|---|---|
| auth_token | Your platform's auth token |
| id | The Tangram ID of the user |
| Key | Value |
|---|---|
| display_name | The user's display name |
| The user's email address | |
| phone_number | The user's phone_number |
| address | The user's address |
field_nlynyhfvamztk3dvvyfyewAdmin Tags |
The field value for "Admin Tags" |
field_j1n4ywekfhxgdwmmscw0gqCategories |
The field value for "Categories" |
field_iu0eodobrhgowrrx5ryzfgLottie File |
The field value for "Lottie File" |
field_hefde2pjxitdj76qkbnrwFile Type |
The field value for "File Type" |
field_6qzwdgqtsuhne0oqroggNot for sale? |
The field value for "Not for sale?" |
field_dklzsrbex5w1ewfnu2gncqDescription |
The field value for "Description" |
field_fkqjbe6z7yn7j5jyuakgDisplay Name |
The field value for "Display Name" |
field_1hnhzbusdl54wk6wzb8ooq |
The field value for "Email" |
field_4wyuya3lktau48rbfjb6uaProfile Photo |
The field value for "Profile Photo" |
field_4jrusvbtbfqvvi028bs4qqTitle |
The field value for "Title" |
field_exxh85wlep8bpbqiyzgmkgPrice |
The field value for "Price" |
field_fswhcu6jdhgbk4bfxkczgFile Name (For listing display purposes) |
The field value for "File Name (For listing display purposes)" |
field_tmmuajl4xigzsxaa9hscxgFile Size (for listing display purposes) |
The field value for "File Size (for listing display purposes)" |
field_3j3lxkaknauznofwcirtwDuration |
The field value for "Duration" |
| Delete a user | DELETE | app.animate.io/api/v1/users/:id |
| Key | Value |
|---|---|
| auth_token | Your platform's auth token |