Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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>"
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("data.attributes.disabled","<boolean>")
json.UpdateString("data.attributes.email","<string>")
json.UpdateString("data.attributes.name","<string>")
json.UpdateString("data.type","users")
json.UpdateString("data.id","<string>")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/users/:user_id",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim id As String
Dim v_type As String
Dim attributesCreated_at As String
Dim Description As String
Dim attributesDisabled As String
Dim attributesModified_at As String
Dim attributesName As String
Dim Public_id As String
Dim Sharing As String
Dim v_Url As String
Dim Created_at As String = jResp.StringOf("data.attributes.created_at")
Dim Disabled As String = jResp.StringOf("data.attributes.disabled")
Dim v_Email As String = jResp.StringOf("data.attributes.email")
Dim Handle As String = jResp.StringOf("data.attributes.handle")
Dim Icon As String = jResp.StringOf("data.attributes.icon")
Dim Modified_at As String = jResp.StringOf("data.attributes.modified_at")
Dim Name As String = jResp.StringOf("data.attributes.name")
Dim Service_account As String = jResp.StringOf("data.attributes.service_account")
Dim Status As String = jResp.StringOf("data.attributes.status")
Dim Title As String = jResp.StringOf("data.attributes.title")
Dim Verified As String = jResp.StringOf("data.attributes.verified")
Dim Id As String = jResp.StringOf("data.id")
Dim DataId As String = jResp.StringOf("data.relationships.org.data.id")
Dim v_Type As String = jResp.StringOf("data.relationships.org.data.type")
Dim dataType As String = jResp.StringOf("data.type")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data.relationships.other_orgs.data")
While i < count_i
jResp.I = i
id = jResp.StringOf("data.relationships.other_orgs.data[i].id")
v_type = jResp.StringOf("data.relationships.other_orgs.data[i].type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("data.relationships.other_users.data")
While i < count_i
jResp.I = i
id = jResp.StringOf("data.relationships.other_users.data[i].id")
v_type = jResp.StringOf("data.relationships.other_users.data[i].type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("data.relationships.roles.data")
While i < count_i
jResp.I = i
id = jResp.StringOf("data.relationships.roles.data[i].id")
v_type = jResp.StringOf("data.relationships.roles.data[i].type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("included")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("included[i].type")
attributesCreated_at = jResp.StringOf("included[i].attributes.created_at")
Description = jResp.StringOf("included[i].attributes.description")
attributesDisabled = jResp.StringOf("included[i].attributes.disabled")
attributesModified_at = jResp.StringOf("included[i].attributes.modified_at")
attributesName = jResp.StringOf("included[i].attributes.name")
Public_id = jResp.StringOf("included[i].attributes.public_id")
Sharing = jResp.StringOf("included[i].attributes.sharing")
v_Url = jResp.StringOf("included[i].attributes.url")
id = jResp.StringOf("included[i].id")
i = i + 1
End While
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}"
}
]
}
