Create

POST

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

Request

This endpoint expects an object.

display_namestringRequired

Name of the Rev organization.

accountstringOptional

Account Id to associate with this Rev organization.

artifactslist of stringsOptional

The IDs of the artifacts to associate with the Rev organization.

custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_fragmentslist of stringsOptional

Schema fragment IDs associated with this Rev organization.

descriptionstringOptional

Description of the Rev organization.

domainstringOptional

Company's domain name. Example - 'devrev.ai'.

environmentenumOptional

Allowed values: productionstagingtest

The environment of the Org. Defaults to 'production' if not specified.

external_refstringOptional

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.

tagslist of objectsOptional

Tags associated with the Rev organization.

tierstringOptional

The tier of the RevOrg.

Response

This endpoint returns an object.

rev_orgobject

POST

1 curl -X POST https://api.devrev.ai/rev-orgs.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "display_name": "display_name"
6 }'

200Successful

1 {
2   "rev_org": {
3     "created_date": "2023-01-01T12:00:00Z",
4     "display_id": "display_id",
5     "id": "id",
6     "modified_date": "2023-01-01T12:00:00Z",
7     "display_name": "display_name",
8     "account": {
9       "display_id": "display_id",
10       "id": "id",
11       "display_name": "display_name"
12     },
13     "artifacts": [
14       {
15         "id": "id"
16       }
17     ],
18     "custom_fields": {
19       "key": "value"
20     },
21     "custom_schema_fragments": [
22       "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
23     ],
24     "description": "description",
25     "domain": "domain",
26     "external_ref": "external_ref",
27     "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
28     "subtype": "subtype",
29     "tags": [
30       {
31         "tag": {
32           "id": "id",
33           "name": "name"
34         }
35       }
36     ]
37   }
38 }

Built with

1	curl -X POST https://api.devrev.ai/rev-orgs.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"display_name": "display_name"
6	}'

1	{
2	"rev_org": {
3	"created_date": "2023-01-01T12:00:00Z",
4	"display_id": "display_id",
5	"id": "id",
6	"modified_date": "2023-01-01T12:00:00Z",
7	"display_name": "display_name",
8	"account": {
9	"display_id": "display_id",
10	"id": "id",
11	"display_name": "display_name"
12	},
13	"artifacts": [
14	{
15	"id": "id"
16	}
17	],
18	"custom_fields": {
19	"key": "value"
20	},
21	"custom_schema_fragments": [
22	"don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
23	],
24	"description": "description",
25	"domain": "domain",
26	"external_ref": "external_ref",
27	"stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
28	"subtype": "subtype",
29	"tags": [
30	{
31	"tag": {
32	"id": "id",
33	"name": "name"
34	}
35	}
36	]
37	}
38	}