Create Contact

Creates a new contact in your Academy. You can create a contact with a password, or, if you use SSO or another login mechanism, you can just use this to ensure that the user has been created, for instance, if you want to add them to a segment before they first visit the site.

post/api/v1/academies/{academy_id}/users

Request

Base URL
https://app.workramp.com
URL
https://app.workramp.com/api/v1/academies/{academy_id}/users
Auth
API key in header Authorization

Path parameters

academy_idstring required

The id of the Academy

Headers

Content-Typestring

Always application/json

Request body

emailstring required

The email address of the Contact

namestring required

The name of the Contact

passwordstring

(Optional) If you'd like the contact to sign in with a password. Not needed when using SSO, magic links, or another login mechanism.

custom_registration_fieldsstring json

JSON dictionary where keys are the "API Name" of your registration field to set, and the values are the values to set. e.g. {"favorite_color": "blue"}

Response

200

urlstring

Example response

{
  "url": "/api/v1/academies/c8be6efc-c511-11ee-8dca-000000000001/users",
  "data": {
    "user": {
      "id": "01902776-8464-76c5-a173-293333b17baa",
      "email": "john@doe.com",
      "display_name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "created_at": "2024-06-17 18:29:56 UTC",
      "custom_registration_field_values": [
        {
          "academy_registration_field_id": "field-id-1234",
          "name": "department",
          "value": "Sales"
        }
      ],
      "status": "Active"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.