Foxpro / Support API / Create Or Update Organization
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcCreated_at
LOCAL lcDetails
LOCAL lcExternal_id
LOCAL lcGroup_id
LOCAL lcId
LOCAL lcName
LOCAL lcNotes
LOCAL lcFugiat5_0
LOCAL lcExercitation_039
LOCAL lcLaboris_60
LOCAL lcShared_comments
LOCAL lcShared_tickets
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/organizations/create_or_update")
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcCreated_at = loJResp.StringOf("organization.created_at")
lcDetails = loJResp.StringOf("organization.details")
lcExternal_id = loJResp.StringOf("organization.external_id")
lcGroup_id = loJResp.StringOf("organization.group_id")
lcId = loJResp.StringOf("organization.id")
lcName = loJResp.StringOf("organization.name")
lcNotes = loJResp.StringOf("organization.notes")
lcFugiat5_0 = loJResp.StringOf("organization.organization_fields.fugiat5_0")
lcExercitation_039 = loJResp.StringOf("organization.organization_fields.exercitation_039")
lcLaboris_60 = loJResp.StringOf("organization.organization_fields.laboris_60")
lcShared_comments = loJResp.StringOf("organization.shared_comments")
lcShared_tickets = loJResp.StringOf("organization.shared_tickets")
lcUpdated_at = loJResp.StringOf("organization.updated_at")
lcV_Url = loJResp.StringOf("organization.url")
i = 0
lnCount_i = loJResp.SizeOfArray("organization.domain_names")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("organization.domain_names[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("organization.tags")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("organization.tags[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/create_or_update
Postman Collection Item JSON
{
"name": "Create Or Update Organization",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"create_or_update"
]
},
"description": "Creates an organization if it doesn't already exist, or updates\nan existing organization. Using this method means one less call\nto check if an organization exists before creating it. You need\nto specify the id or external id when updating\nan organization to avoid a duplicate error response. Name is\nnot available as a matching criteria.\n\n#### Allowed For\n\n* Agents, with restrictions on certain actions\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"create_or_update"
]
}
},
"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": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"create_or_update"
]
}
},
"status": "Created",
"code": 201,
"_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}"
}
]
}
