DataFlex / Support API / Update Organization
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sStrVal
String sCreated_at
String sDetails
String sExternal_id
String sGroup_id
String sId
String sName
String sNotes
String sFugiat5_0
String sExercitation_039
String sLaboris_60
String sShared_comments
String sShared_tickets
String sUpdated_at
String sV_Url
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "PUT" "https://example.zendesk.com/api/v2/organizations/:organization_id" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "organization": {
// "created_at": "<string>",
// "details": "<string>",
// "domain_names": [
// "<string>",
// "<string>"
// ],
// "external_id": "<string>",
// "group_id": "<integer>",
// "id": "<integer>",
// "name": "<string>",
// "notes": "<string>",
// "organization_fields": {
// "fugiat5_0": "<string>",
// "exercitation_039": "<string>",
// "laboris_60": "<string>"
// },
// "shared_comments": "<boolean>",
// "shared_tickets": "<boolean>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "updated_at": "<string>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "organization.created_at" To sCreated_at
Get ComStringOf Of hoJResp "organization.details" To sDetails
Get ComStringOf Of hoJResp "organization.external_id" To sExternal_id
Get ComStringOf Of hoJResp "organization.group_id" To sGroup_id
Get ComStringOf Of hoJResp "organization.id" To sId
Get ComStringOf Of hoJResp "organization.name" To sName
Get ComStringOf Of hoJResp "organization.notes" To sNotes
Get ComStringOf Of hoJResp "organization.organization_fields.fugiat5_0" To sFugiat5_0
Get ComStringOf Of hoJResp "organization.organization_fields.exercitation_039" To sExercitation_039
Get ComStringOf Of hoJResp "organization.organization_fields.laboris_60" To sLaboris_60
Get ComStringOf Of hoJResp "organization.shared_comments" To sShared_comments
Get ComStringOf Of hoJResp "organization.shared_tickets" To sShared_tickets
Get ComStringOf Of hoJResp "organization.updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "organization.url" To sV_Url
Move 0 To i
Get ComSizeOfArray Of hoJResp "organization.domain_names" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "organization.domain_names[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "organization.tags" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "organization.tags[i]" To sStrVal
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/:organization_id
Postman Collection Item JSON
{
"name": "Update Organization",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
":organization_id"
],
"variable": [
{
"key": "organization_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n\n* Admins\n* Agents\n\nAgents with no permissions restrictions can only update \"notes\" on organizations.\n\n**Note** Updating an organization overwrites all existing `domain_names` values. To prevent this, submit a complete list of `domain_names` associated with the organization in your request.\n\n#### Example Request\n\n```js\n{\n \"organization\": {\n \"notes\": \"Something interesting\"\n }\n}\n```\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
":organization_id"
],
"variable": [
{
"key": "organization_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"organization\": {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"fugiat5_0\": \"<string>\",\n \"exercitation_039\": \"<string>\",\n \"laboris_60\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
":organization_id"
],
"variable": [
{
"key": "organization_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
