Users

Identify user

Changed on

Create or update a user with the provided identification data. When you identify an existing user, the system merges the properties you specify with what is currently set on the user, updating only the fields included in your requests.

put/v1/users/{user_id}

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/users/{user_id}
  • Auth: HTTP bearer

Path parameters

user_idstring required

The unique identifier of the user.

Request body

avatarstring nullable

A URL for the avatar of the user.

channel_dataInlineChannelDataRequest

A request to set channel data for a type of channel inline.

created_atstring date-time nullable

The creation date of the user from your system.

emailstring nullable

The primary email address for the user.

localestring nullable

The locale of the user. Used for message localization.

namestring nullable

Display name of the user.

phone_numberstring nullable

The E.164 phone number of the user (required for SMS channels).

preferencesInlinePreferenceSetRequest

Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences rather than replacing them.

timezonestring nullable

The timezone of the user. Must be a valid tz database time zone string. Used for recurring schedules.

Example request

{
  "channel_data": {
    "97c5837d-c65c-4d54-aa39-080eeb81c69d": {
      "tokens": [
        "push_token_123"
      ]
    }
  },
  "email": "ian.malcolm@chaos.theory",
  "name": "Dr. Ian Malcolm",
  "preferences": {
    "default": {
      "channel_types": {
        "email": true
      },
      "workflows": {
        "dinosaurs-loose": {
          "channel_types": {
            "email": true
          }
        }
      }
    }
  },
  "timezone": "America/New_York"
}

Response

OK

__typenamestring required

The typename of the schema.

avatarstring nullable

A URL for the avatar of the user.

created_atstring date-time nullable

The creation date of the user from your system.

emailstring nullable

The primary email address for the user.

idstring required

The unique identifier of the user.

namestring nullable

Display name of the user.

phone_numberstring nullable

The E.164 phone number of the user (required for SMS channels).

timezonestring nullable

The timezone of the user. Must be a valid tz database time zone string. Used for recurring schedules.

updated_atstring date-time required

The timestamp when the resource was last updated.

Example response

{
  "__typename": "User",
  "created_at": null,
  "email": "ian.malcolm@chaos.theory",
  "id": "user_id",
  "name": "Dr. Ian Malcolm",
  "updated_at": "2024-05-22T12:00:00Z"
}

Changes

  • 6f88a4142e34Revision changes
    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

  • fcba175ebc76Revision changes
    • breaking

      the request property /// became not nullable

    • breaking

      the /// request property type changed from boolean to no type

    • info

      added subschema #1 subschema #3 to the /// request property anyOf list