Platform

PATCH /members/{id}

Changed on

PATCH operation for /members/{id}

patch/members/{id}

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/members/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Request body

idinteger
first_namestring required
last_namestring required
namestring
emailstring email required
rolestring
account_type'admin' | 'manager' | 'lead' | 'coordinator' | 'onboarder' | 'contributor' | 'view_only' | 'api' required
avatarstring
created_atstring date-time
modified_atstring date-time
invited_atstring date-time
status'active' | 'deactivated' | 'invited' | 'expired'
external_idstring
last_loginstring
slack_member_idstring
rolesstring
role_idsstring[]
featuresobject
fora_idstring
meeting_insightsboolean

Enables Meeting Insights feature

manage_chatbotboolean

Enables managing chatbot feature

manage_billingboolean

Enables managing billing feature

record_restriction'standard' | 'restricted' | 'fully_restricted'

Controls visibility of Context records owned by this user.

send_inviteboolean
titlestring
reports_to_idstring
team_idstring
teamstring
direct_report_countinteger
customstring

Response

Successful response

idinteger
first_namestring required
last_namestring required
namestring
emailstring email required
rolestring
account_type'admin' | 'manager' | 'lead' | 'coordinator' | 'onboarder' | 'contributor' | 'view_only' | 'api' required
avatarstring
created_atstring date-time
modified_atstring date-time
invited_atstring date-time
status'active' | 'deactivated' | 'invited' | 'expired'
external_idstring
last_loginstring
slack_member_idstring
rolesstring
role_idsstring[]
featuresobject
fora_idstring
meeting_insightsboolean

Enables Meeting Insights feature

manage_chatbotboolean

Enables managing chatbot feature

manage_billingboolean

Enables managing billing feature

record_restriction'standard' | 'restricted' | 'fully_restricted'

Controls visibility of Context records owned by this user.

send_inviteboolean
titlestring
reports_to_idstring
team_idstring
teamstring
direct_report_countinteger
customstring

Changes

  • 5a031114a9f6Revision 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 optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • c64f0cb20b75Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request optional property became not read-only

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response optional property became not read-only for the status