lianja / Support API / Create Membership
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/group_memberships")
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "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
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "group_membership": {
// "user_id": "<integer>",
// "group_id": "<integer>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcUser_id = loJResp.StringOf("group_membership.user_id")
lcGroup_id = loJResp.StringOf("group_membership.group_id")
lcCreated_at = loJResp.StringOf("group_membership.created_at")
lcDefault = loJResp.StringOf("group_membership.default")
lcId = loJResp.StringOf("group_membership.id")
lcUpdated_at = loJResp.StringOf("group_membership.updated_at")
lcV_Url = loJResp.StringOf("group_membership.url")
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/group_memberships
Postman Collection Item JSON
{
"name": "Create Membership",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/group_memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"group_memberships"
],
"variable": [
{
"key": "user_id",
"value": "<integer>",
"description": "(Required) The id of the user"
},
{
"key": "group_id",
"value": "<integer>",
"description": "(Required) The ID of the group"
}
]
},
"description": "Assigns an agent to a given group.\n\n#### Allowed For\n\n* Admins\n* Agents assigned to a custom role with permissions to manage group memberships (Enterprise only)\n"
},
"response": [
{
"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/group_memberships",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"group_memberships"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"group_membership\": {\n \"user_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}