rev-orgs

Create

POST
Creates a Rev organization in the authenticated user's Dev organization.

Request

This endpoint expects an object.
display_name
stringRequired
Name of the Rev organization.
account
stringOptional
Account Id to associate with this Rev organization.
artifacts
list of stringsOptional
The IDs of the artifacts to associate with the Rev organization.
custom_fields
map from strings to anyOptional
Application-defined custom fields.
custom_schema_fragments
list of stringsOptional
Schema fragment IDs associated with this Rev organization.
description
stringOptional
Description of the Rev organization.
domain
stringOptional
Company's domain name. Example - 'devrev.ai'.
environment
enumOptional
The environment of the Org. Defaults to 'production' if not specified.
Allowed values: productionstagingtest
external_ref
stringOptional
External ref is a custom unique identifier which is a reference to an unique id for this organization's data in some system of records.
tags
list of objectsOptional
Tags associated with the Rev organization.
tier
stringOptional
The tier of the RevOrg.

Response

This endpoint returns an object
rev_org
object
POST
1curl -X POST https://api.devrev.ai/rev-orgs.create \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "display_name": "display_name"
6}'
200
Successful
1{
2  "rev_org": {
3    "id": "id",
4    "account": {
5      "id": "id",
6      "display_id": "display_id",
7      "display_name": "display_name"
8    },
9    "artifacts": [
10      {
11        "id": "id"
12      }
13    ],
14    "created_date": "2023-01-01T12:00:00Z",
15    "custom_fields": {
16      "custom_fields": {
17        "key": "value"
18      }
19    },
20    "custom_schema_fragments": [
21      "custom_schema_fragments"
22    ],
23    "description": "description",
24    "display_id": "display_id",
25    "display_name": "display_name",
26    "domain": "domain",
27    "external_ref": "external_ref",
28    "modified_date": "2023-01-01T12:00:00Z",
29    "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
30    "subtype": "subtype",
31    "tags": [
32      {
33        "tag": {
34          "id": "id",
35          "name": "name"
36        }
37      }
38    ]
39  }
40}
Built with