.. index:: User, UserProfile .. _user_profile: User profile ============ A user profile is a visual display of personal data associated with a specific user. This data will only be displayed for users that purchased the "marktplaats extra", "bedrijfs profilering" products. Or users that are admarkt customers. Information on buying features can be found at :ref:`buy-feature `. .. _user-profile-fields: Fields ------ .. apifields:: .. apifield:: :name: title :type: string :constraints: max. 150 chars, cannot contain emails or urls :required: true :updateable: true :writable: true :description: The profile title. .. apifield:: :name: description :type: string :constraints: max. 500 chars :required: true :updateable: true :writable: true :description: The profile description .. apifield:: :name: videoUrl :type: string :constraints: max. 150 chars :required: false :updateable: true :writable: true :description: From where to load the video .. apifield:: :name: mission :type: string :constraints: max. 500 chars :required: false :updateable: true :writable: true :description: The mission statement .. apifield:: :name: sellerUrl :type: string :constraints: max. 150 chars :required: false :updateable: true :writable: true :description: The seller url .. apifield:: :name: awards :type: string :constraints: max. 500 chars :required: false :updateable: true :writable: true :description: The awards Relations --------- .. relations:: .. relation:: :name: mp:profile-image .. relation:: :name: mp:backdrop-image .. relation:: :name: mp:logo-image Reference --------- .. endpoint:: GET /v1/users/{userId}/profile Get a user's profile. .. endpoint:: PUT /v1/users/{userId}/profile Update a user's profile .. endpoint:: PATCH /v1/users/{userId}/profile Do a partial update of a user's profile Errors ------ .. errors:: .. error:: :http: 400 :code: validation-failure Validation of the profile failed. There should be more information in the field errors Field errors ------------ .. fielderrors:: .. error:: :field: :code: input-invalid :description: The value for this field is invalid. .. error:: :field: :code: input-too-long :description: The length of the supplied value exceeds the maximum allowed length for this field :value: the maximum allowed length .. error:: :field: :code: missing-required-field :description: A required field is missing or empty (while that is not allowed). Examples -------- .. include:: examples/get-user-profile-example.rst