{"__v":20,"_id":"5702d626d4a89736004f29ae","category":{"__v":29,"_id":"55f0b2b5f3735d0d00692001","pages":["55f0b2b6f3735d0d00692003","55f0b536f3735d0d0069200b","55f0c6eaf3735d0d00692097","55fa0c0f8065a10d004e5b77","55fa0db60e1f1f1700a1f6ec","55fa0e9ea663c00d00773d9c","55fa0f0eaba81f0d00a115a4","55fa0f9e17b9d00d00969e55","55fa1008aba81f0d00a115a5","55fa13e117b9d00d00969e68","55fa14460e1f1f1700a1f6f4","55fa14f517b9d00d00969e70","55fa166b8065a10d004e5b8b","55fa16a8aba81f0d00a115b0","55fa175aaba81f0d00a115be","55fa17868065a10d004e5b94","55faf3f6626c341700fd9e93","55faf49d825d5f19001fa381","55faf4c317b9d00d00969f44","560096b297f69f1700f21a44","56009d7081a9670d006d1470","56009e653aa0520d00da0c0b","563ceed6260dde0d00c5ea2e","563cf07d9799fb0d00047725","563d008eae97cc0d00a9009f","563d3fa38894d20d00014f64","5669f229a4968c2d001d8084","56cbb3d76b06f11d0040f154","56cf4d11336aa60b0086a235"],"project":"55f0757d4624ec2d00814345","version":"55f0b2b5f3735d0d00691ffe","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T22:10:31.668Z","from_sync":false,"order":6,"slug":"rest-api","title":"REST API"},"parentDoc":null,"project":"55f0757d4624ec2d00814345","user":"55f0756a1e63fc37004b8d2b","version":{"__v":9,"_id":"55f0b2b5f3735d0d00691ffe","project":"55f0757d4624ec2d00814345","createdAt":"2015-09-09T22:29:09.118Z","releaseDate":"2015-09-09T22:29:09.118Z","categories":["55f0b2b5f3735d0d00691fff","55f0b2b5f3735d0d00692000","55f0b2b5f3735d0d00692001","55f0bd67d5d8fc0d00ca6f44","55f0cde9d5d8fc0d00ca6f55","563a8a62a8ba320d00106830","563a8ac9a8ba320d00106832","563d410f31f7580d00511e53","563d411de79f670d00a10a5f","563d412a31f7580d00511e54","566a206f74d574170070b640"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T21:01:26.610Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":28,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Private APIs require administrative access\",\n  \"body\": \"For administrative access for your organization, you will need to [contact us](mailto:developersupport:::at:::tigertext.com?Subject=TigerConnect%20Question).  \\n\\nNote: If you are part of an existing TigerText organization, you may need to reach out to your current administrator for approval.\"\n}\n[/block]\nEach endpoint provides details of the parameters along with an API Explorer to make it easy to interact with them.  \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Adding a User to an Organization\"\n}\n[/block]\nSince the our platform only allows one account for a specific username, email or phone number, adding a user to an organization requires an initial account lookup.   There are two steps for an admin to add a user to an organization.  \n\n**Check to see if that user account exists**\nTo check if a user exists in TigerText you can use our [GET /user_lookup/:user](doc:user_lookupuser) API with your admin api key / secret using basic authentication. \n\n**If the user account exists...**\nThen you can add the existing user account to your organization using [POST /user/:user/organization](doc:useruserorganization) API with your admin api key / secret using basic authentication. \n\n**If the user account does not exist...**\nYou will need to need to create the user account and add it to the organization. You can do this with a single [POST /user](doc:user) API call.  Be sure to provide the specified specified organization you’d like to add the user to as a part of the header TT-X-Organization-Key.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"User\"\n}\n[/block]\nGet information about a specific user or create a new user.  \n\n* <a href=\"https://developer.tigertext.com/v2/docs/user_lookupuser\" target=\"_blank\">GET /user_lookup/:user</a>\n* <a href=\"https://developer.tigertext.com/v2/docs/user\" target=\"_blank\">POST /user</a> \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"User Organization Management\"\n}\n[/block]\nAdd or remove existing users to an organization.\n\n* <a href=\"https://developer.tigertext.com/v2/docs/useruserorganization\" target=\"_blank\">POST /user/:user/organization</a>\n* <a href=\"https://developer.tigertext.com/v2/docs/useruserorganizatinorganization\" target=\"_blank\">DELETE /user/:user/organization/:organization</a>\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"User Organization Role Management\"\n}\n[/block]\nAssign or remove specific [user roles](doc:messaging-users-and-groups#user-roles) within an organization.\n\n* <a href=\"https://developer.tigertext.com/v2/docs/useruserroles\" target=\"_blank\">GET /user/:user/organization/:organization/roles</a>\n* <a href=\"https://developer.tigertext.com/v2/docs/useruserroles-1\" target=\"_blank\">POST /user/:user/organization/:organization/roles/:role</a>\n* <a href=\"https://developer.tigertext.com/v2/docs/useruserorganizationorganizationrolesrole\" target=\"_blank\">DELETE /user/:user/organization/:organization/roles/:role</a>\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Organization\"\n}\n[/block]\nGet information about an organization, create a new organization or delete an existing organization.\n\n* <a href=\"https://developer.tigertext.com/v2/docs/organization\" target=\"_blank\">POST /organization</a>\n* <a href=\"https://developer.tigertext.com/v2/docs/organizationorganization-1\" target=\"_blank\">POST /organization/:organization</a>\n* <a href=\"https://developer.tigertext.com/v2/docs/organizationorganization\" target=\"_blank\">GET /organization/:organization</a>","excerpt":"","slug":"admin-api-endpoints","type":"basic","title":"Admin API Endpoints"}

Admin API Endpoints


[block:callout] { "type": "info", "title": "Private APIs require administrative access", "body": "For administrative access for your organization, you will need to [contact us](mailto:developersupport@tigertext.com?Subject=TigerConnect%20Question). \n\nNote: If you are part of an existing TigerText organization, you may need to reach out to your current administrator for approval." } [/block] Each endpoint provides details of the parameters along with an API Explorer to make it easy to interact with them. [block:api-header] { "type": "basic", "title": "Adding a User to an Organization" } [/block] Since the our platform only allows one account for a specific username, email or phone number, adding a user to an organization requires an initial account lookup. There are two steps for an admin to add a user to an organization. **Check to see if that user account exists** To check if a user exists in TigerText you can use our [GET /user_lookup/:user](doc:user_lookupuser) API with your admin api key / secret using basic authentication. **If the user account exists...** Then you can add the existing user account to your organization using [POST /user/:user/organization](doc:useruserorganization) API with your admin api key / secret using basic authentication. **If the user account does not exist...** You will need to need to create the user account and add it to the organization. You can do this with a single [POST /user](doc:user) API call. Be sure to provide the specified specified organization you’d like to add the user to as a part of the header TT-X-Organization-Key. [block:api-header] { "type": "basic", "title": "User" } [/block] Get information about a specific user or create a new user. * <a href="https://developer.tigertext.com/v2/docs/user_lookupuser" target="_blank">GET /user_lookup/:user</a> * <a href="https://developer.tigertext.com/v2/docs/user" target="_blank">POST /user</a> [block:api-header] { "type": "basic", "title": "User Organization Management" } [/block] Add or remove existing users to an organization. * <a href="https://developer.tigertext.com/v2/docs/useruserorganization" target="_blank">POST /user/:user/organization</a> * <a href="https://developer.tigertext.com/v2/docs/useruserorganizatinorganization" target="_blank">DELETE /user/:user/organization/:organization</a> [block:api-header] { "type": "basic", "title": "User Organization Role Management" } [/block] Assign or remove specific [user roles](doc:messaging-users-and-groups#user-roles) within an organization. * <a href="https://developer.tigertext.com/v2/docs/useruserroles" target="_blank">GET /user/:user/organization/:organization/roles</a> * <a href="https://developer.tigertext.com/v2/docs/useruserroles-1" target="_blank">POST /user/:user/organization/:organization/roles/:role</a> * <a href="https://developer.tigertext.com/v2/docs/useruserorganizationorganizationrolesrole" target="_blank">DELETE /user/:user/organization/:organization/roles/:role</a> [block:api-header] { "type": "basic", "title": "Organization" } [/block] Get information about an organization, create a new organization or delete an existing organization. * <a href="https://developer.tigertext.com/v2/docs/organization" target="_blank">POST /organization</a> * <a href="https://developer.tigertext.com/v2/docs/organizationorganization-1" target="_blank">POST /organization/:organization</a> * <a href="https://developer.tigertext.com/v2/docs/organizationorganization" target="_blank">GET /organization/:organization</a>