Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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": [
# {
# "type": "user_invitations",
# "relationships": {
# "user": {
# "data": {
# "id": "<string>",
# "type": "users"
# }
# }
# }
# },
# {
# "type": "user_invitations",
# "relationships": {
# "user": {
# "data": {
# "id": "<string>",
# "type": "users"
# }
# }
# }
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "data[0].type" "user_invitations"
CkJsonObject_UpdateString $json "data[0].relationships.user.data.id" "<string>"
CkJsonObject_UpdateString $json "data[0].relationships.user.data.type" "users"
CkJsonObject_UpdateString $json "data[1].type" "user_invitations"
CkJsonObject_UpdateString $json "data[1].relationships.user.data.id" "<string>"
CkJsonObject_UpdateString $json "data[1].relationships.user.data.type" "users"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.app.ddog-gov.com/api/v2/user_invitations" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "attributes": {
# "created_at": "<dateTime>",
# "expires_at": "<dateTime>",
# "invite_type": "<string>",
# "uuid": "<string>"
# },
# "id": "<string>",
# "relationships": {
# "user": {
# "data": {
# "id": "<string>",
# "type": "users"
# }
# }
# },
# "type": "user_invitations"
# },
# {
# "attributes": {
# "created_at": "<dateTime>",
# "expires_at": "<dateTime>",
# "invite_type": "<string>",
# "uuid": "<string>"
# },
# "id": "<string>",
# "relationships": {
# "user": {
# "data": {
# "id": "<string>",
# "type": "users"
# }
# }
# },
# "type": "user_invitations"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Created_at [CkJsonObject_stringOf $jResp "data[i].attributes.created_at"]
set Expires_at [CkJsonObject_stringOf $jResp "data[i].attributes.expires_at"]
set Invite_type [CkJsonObject_stringOf $jResp "data[i].attributes.invite_type"]
set Uuid [CkJsonObject_stringOf $jResp "data[i].attributes.uuid"]
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set Id [CkJsonObject_stringOf $jResp "data[i].relationships.user.data.id"]
set v_Type [CkJsonObject_stringOf $jResp "data[i].relationships.user.data.type"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": [
{
"type": "user_invitations",
"relationships": {
"user": {
"data": {
"id": "<string>",
"type": "users"
}
}
}
},
{
"type": "user_invitations",
"relationships": {
"user": {
"data": {
"id": "<string>",
"type": "users"
}
}
}
}
]
}'
https://api.app.ddog-gov.com/api/v2/user_invitations
Postman Collection Item JSON
{
"name": "Send invitation emails",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
},
"description": "Sends emails to one or more users inviting them to join the organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"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 {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"expires_at\": \"<dateTime>\",\n \"invite_type\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n },\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"expires_at\": \"<dateTime>\",\n \"invite_type\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"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 {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"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": "POST",
"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 {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "POST",
"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 {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"user_invitations\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations"
]
}
},
"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}"
}
]
}
