Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "data": {
; "attributes": {
; "disabled": "<boolean>",
; "email": "<string>",
; "name": "<string>"
; },
; "type": "users",
; "id": "<string>"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("data.attributes.disabled","<boolean>")
$oJson.UpdateString("data.attributes.email","<string>")
$oJson.UpdateString("data.attributes.name","<string>")
$oJson.UpdateString("data.type","users")
$oJson.UpdateString("data.id","<string>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/users/:user_id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "attributes": {
; "created_at": "<dateTime>",
; "disabled": "<boolean>",
; "email": "<string>",
; "handle": "<string>",
; "icon": "<string>",
; "modified_at": "<dateTime>",
; "name": "<string>",
; "service_account": "<boolean>",
; "status": "<string>",
; "title": "<string>",
; "verified": "<boolean>"
; },
; "id": "<string>",
; "relationships": {
; "org": {
; "data": {
; "id": "<string>",
; "type": "orgs"
; }
; },
; "other_orgs": {
; "data": [
; {
; "id": "<string>",
; "type": "orgs"
; },
; {
; "id": "<string>",
; "type": "orgs"
; }
; ]
; },
; "other_users": {
; "data": [
; {
; "id": "<string>",
; "type": "users"
; },
; {
; "id": "<string>",
; "type": "users"
; }
; ]
; },
; "roles": {
; "data": [
; {
; "id": "<string>",
; "type": "roles"
; },
; {
; "id": "<string>",
; "type": "roles"
; }
; ]
; }
; },
; "type": "users"
; },
; "included": [
; {
; "type": "orgs",
; "attributes": {
; "created_at": "<dateTime>",
; "description": "<string>",
; "disabled": "<boolean>",
; "modified_at": "<dateTime>",
; "name": "<string>",
; "public_id": "<string>",
; "sharing": "<string>",
; "url": "<string>"
; },
; "id": "<string>"
; },
; {
; "type": "orgs",
; "attributes": {
; "created_at": "<dateTime>",
; "description": "<string>",
; "disabled": "<boolean>",
; "modified_at": "<dateTime>",
; "name": "<string>",
; "public_id": "<string>",
; "sharing": "<string>",
; "url": "<string>"
; },
; "id": "<string>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId
Local $sV_type
Local $sAttributesCreated_at
Local $sDescription
Local $sAttributesDisabled
Local $sAttributesModified_at
Local $sAttributesName
Local $sPublic_id
Local $sSharing
Local $sV_Url
Local $sCreated_at = $oJResp.StringOf("data.attributes.created_at")
Local $sDisabled = $oJResp.StringOf("data.attributes.disabled")
Local $sV_Email = $oJResp.StringOf("data.attributes.email")
Local $sHandle = $oJResp.StringOf("data.attributes.handle")
Local $sIcon = $oJResp.StringOf("data.attributes.icon")
Local $sModified_at = $oJResp.StringOf("data.attributes.modified_at")
Local $sName = $oJResp.StringOf("data.attributes.name")
Local $sService_account = $oJResp.StringOf("data.attributes.service_account")
Local $sStatus = $oJResp.StringOf("data.attributes.status")
Local $sTitle = $oJResp.StringOf("data.attributes.title")
Local $sVerified = $oJResp.StringOf("data.attributes.verified")
Local $sId = $oJResp.StringOf("data.id")
Local $sDataId = $oJResp.StringOf("data.relationships.org.data.id")
Local $sV_Type = $oJResp.StringOf("data.relationships.org.data.type")
Local $sDataType = $oJResp.StringOf("data.type")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.relationships.other_orgs.data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data.relationships.other_orgs.data[i].id")
$sV_type = $oJResp.StringOf("data.relationships.other_orgs.data[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("data.relationships.other_users.data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data.relationships.other_users.data[i].id")
$sV_type = $oJResp.StringOf("data.relationships.other_users.data[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("data.relationships.roles.data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data.relationships.roles.data[i].id")
$sV_type = $oJResp.StringOf("data.relationships.roles.data[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("included")
While $i < $iCount_i
$oJResp.I = $i
$sV_type = $oJResp.StringOf("included[i].type")
$sAttributesCreated_at = $oJResp.StringOf("included[i].attributes.created_at")
$sDescription = $oJResp.StringOf("included[i].attributes.description")
$sAttributesDisabled = $oJResp.StringOf("included[i].attributes.disabled")
$sAttributesModified_at = $oJResp.StringOf("included[i].attributes.modified_at")
$sAttributesName = $oJResp.StringOf("included[i].attributes.name")
$sPublic_id = $oJResp.StringOf("included[i].attributes.public_id")
$sSharing = $oJResp.StringOf("included[i].attributes.sharing")
$sV_Url = $oJResp.StringOf("included[i].attributes.url")
$sId = $oJResp.StringOf("included[i].id")
$i = $i + 1
Wend
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"disabled": "<boolean>",
"email": "<string>",
"name": "<string>"
},
"type": "users",
"id": "<string>"
}
}'
https://api.app.ddog-gov.com/api/v2/users/:user_id
Postman Collection Item JSON
{
"name": "Update a user",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "<string>"
}
]
},
"description": "Edit a user. Can only be used with an application key belonging\nto an administrator user."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"type\": \"users\",\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
