PUT login/users/:user id/data

(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
−
#REDIRECT [[PUT login/users/:user id/data PT-BR]]
+
== Description ==
 +
 
 +
Updates user custom profile information.
 +
 
 +
== Resource URL ==
 +
 
 +
  PUT https://api.socialidnow.com/v1/marketing/login/users/:user_id/data
 +
 
 +
== Parameters ==
 +
 
 +
=== URL Parameters ===
 +
 
 +
{|
 +
! align="left" width="200px"  | user_id
 +
| width="200px" | required
 +
| user identifier.
 +
|}
 +
 
 +
=== JSON Parameters ===
 +
 
 +
{|
 +
! align="left" width="200px"  | object
 +
| width="200px" | required
 +
| a hash in the format field:value, with the necessary fields to update the object:
 +
|-
 +
! align="left" width="180px"  style="padding-left: 20px" | [fields]
 +
| width="200px" | optional
 +
| custom fields defined in the schema.
 +
|}
 +
 
 +
== Authentication ==
 +
 
 +
This API requires Marketing Account authentication. See [[Authentication]].
 +
 
 +
== Response ==
 +
 
 +
=== Response Status ===
 +
 
 +
{|
 +
! align="left" width="200px" | ok (200)
 +
| The profile was updated successfully.
 +
|-
 +
! align="left" width="200px" | bad_request (400)
 +
| Some required parameter was not informed.
 +
|-
 +
! align="left" width="200px" | unauthorized (401)
 +
| The authentication is wrong. See [[Authentication]].
 +
|-
 +
! align="left" width="200px" | forbidden (403)
 +
| The Marketing Account does not have access to this user.
 +
|-
 +
! align="left" width="200px" | not_found (404)
 +
| The user was not found.
 +
|-
 +
! align="left" width="200px" | unprocessable_entity (422)
 +
| Validation error in the field "object".
 +
|-
 +
! align="left" width="200px" | internal_server_error (500)
 +
| An unknown error happened.
 +
|}
 +
 
 +
== Examples ==
 +
 
 +
=== Request ===
 +
 
 +
Updates the profile of user "340".
 +
 
 +
curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users/340/data' \
 +
-d '{
 +
      "object": {
 +
        "category":"premium"
 +
      }
 +
    }' \
 +
-H 'Content-type: application/json' \
 +
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 +
 
 +
=== Response ===
 +
 
 +
==== Response Headers ====
 +
 
 +
HTTP/1.1 200 Ok
 +
Status: 200

Revision as of 23:34, 3 November 2014

Contents

Description

Updates user custom profile information.

Resource URL 

  PUT https://api.socialidnow.com/v1/marketing/login/users/:user_id/data

Parameters

URL Parameters

user_id required user identifier.

JSON Parameters

object required a hash in the format field:value, with the necessary fields to update the object:
[fields] optional custom fields defined in the schema.

Authentication

This API requires Marketing Account authentication. See Authentication.

Response

Response Status

ok (200) The profile was updated successfully.
bad_request (400) Some required parameter was not informed.
unauthorized (401) The authentication is wrong. See Authentication.
forbidden (403) The Marketing Account does not have access to this user.
not_found (404) The user was not found.
unprocessable_entity (422) Validation error in the field "object".
internal_server_error (500) An unknown error happened.

Examples

Request

Updates the profile of user "340". 

curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users/340/data' \
-d '{
      "object": {
        "category":"premium"
      }
    }' \
-H 'Content-type: application/json' \
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers 

HTTP/1.1 200 Ok
Status: 200
Retrieved from "https://dev.socialidnow.com/index.php?title=PUT_login/users/:user_id/data&oldid=1448"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox