Chilkat Online Tools

C / Squadcast API V3 / Add User

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *v_type;
    int time;
    const char *Id;
    const char *First_name;
    const char *Last_name;
    const char *v_Email;
    const char *Dial_code;
    const char *Phone_number;
    const char *Secondary_emails;
    BOOL Email_verified;
    const char *Time_zone;
    const char *Title;
    const char *Bio;
    BOOL User_image;
    int i;
    int count_i;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttp_Create();

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "email": "<string>",
    //   "role": "<string>",
    //   "first_name": "<string>",
    //   "last_name": "<string>"
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"email","<string>");
    CkJsonObject_UpdateString(json,"role","<string>");
    CkJsonObject_UpdateString(json,"first_name","<string>");
    CkJsonObject_UpdateString(json,"last_name","<string>");

    CkHttp_SetRequestHeader(http,"Authorization","");
    CkHttp_SetRequestHeader(http,"Content-Type","application/json");

    resp = CkHttp_PostJson3(http,"https://api.squadcast.com/v3/users","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": {
    //     "id": "5e9c204dbde1298f6bcb5ef2",
    //     "first_name": "Manigandan",
    //     "last_name": "Dharmalingam",
    //     "email": "manigandan@squadcast.com",
    //     "contact": {
    //       "dial_code": "",
    //       "phone_number": ""
    //     },
    //     "secondary_emails": null,
    //     "email_verified": false,
    //     "time_zone": "",
    //     "title": "",
    //     "bio": "",
    //     "notification_rules": [
    //       {
    //         "type": "Email",
    //         "time": 0
    //       },
    //       {
    //         "type": "Push",
    //         "time": 0
    //       },
    //       {
    //         "type": "SMS",
    //         "time": 1
    //       },
    //       {
    //         "type": "Phone",
    //         "time": 2
    //       }
    //     ],
    //     "user_image": false
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Id = CkJsonObject_stringOf(jResp,"data.id");
    First_name = CkJsonObject_stringOf(jResp,"data.first_name");
    Last_name = CkJsonObject_stringOf(jResp,"data.last_name");
    v_Email = CkJsonObject_stringOf(jResp,"data.email");
    Dial_code = CkJsonObject_stringOf(jResp,"data.contact.dial_code");
    Phone_number = CkJsonObject_stringOf(jResp,"data.contact.phone_number");
    Secondary_emails = CkJsonObject_stringOf(jResp,"data.secondary_emails");
    Email_verified = CkJsonObject_BoolOf(jResp,"data.email_verified");
    Time_zone = CkJsonObject_stringOf(jResp,"data.time_zone");
    Title = CkJsonObject_stringOf(jResp,"data.title");
    Bio = CkJsonObject_stringOf(jResp,"data.bio");
    User_image = CkJsonObject_BoolOf(jResp,"data.user_image");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"data.notification_rules");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        v_type = CkJsonObject_stringOf(jResp,"data.notification_rules[i].type");
        time = CkJsonObject_IntOf(jResp,"data.notification_rules[i].time");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X POST
	-H "Authorization: "
	-H "Content-Type: application/json"
	-d '{
    "email": "<string>",
    "role": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
}'
https://api.squadcast.com/v3/users

Postman Collection Item JSON

{
  "name": "Add User",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"email\": \"<string>\",\n    \"role\": \"<string>\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/users",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "users"
      ]
    },
    "description": "Add user to the organization with given role if not exists. Returns the user object in response. \nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope."
  },
  "response": [
    {
      "name": "Unprocessable Entity",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
      "code": 422,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": {\n  \"id\": \"5e9c204dbde1298f6bcb5ef2\",\n  \"first_name\": \"Manigandan\",\n  \"last_name\": \"Dharmalingam\",\n  \"email\": \"manigandan@squadcast.com\",\n  \"contact\": {\n   \"dial_code\": \"\",\n   \"phone_number\": \"\"\n  },\n  \"secondary_emails\": null,\n  \"email_verified\": false,\n  \"time_zone\": \"\",\n  \"title\": \"\",\n  \"bio\": \"\",\n  \"notification_rules\": [\n   {\n    \"type\": \"Email\",\n    \"time\": 0\n   },\n   {\n    \"type\": \"Push\",\n    \"time\": 0\n   },\n   {\n    \"type\": \"SMS\",\n    \"time\": 1\n   },\n   {\n    \"type\": \"Phone\",\n    \"time\": 2\n   }\n  ],\n  \"user_image\": false\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": 400,\n  \"error_message\": \"email required\"\n }\n}"
    },
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": 409,\n  \"error_message\": \"cannot add same user manigandan2293@gmail.com again to the organization\"\n }\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": 401,\n  \"error_message\": \"invalid access token\"\n }\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"email\": \"manigandan@squadcast.com\",\n    \"role\": \"admin\",\n    \"first_name\": \"Manigandan\",\n    \"last_name\": \"Dharmalingam\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    }
  ]
}