Create Group

POST

Create an entity group

Request

This endpoint expects an object.

emailToNamestringOptional

entityIdslist of stringsOptional

List of entity IDs or foreign IDs

foreignIdstringOptional

namestringOptional

Response

This endpoint returns an object

idstring

entitieslist of objects

foreignIdstringOptional

namestringOptional

emailToNamestringOptional

POST

1 curl -X POST https://api.mercoa.com/entityGroup \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "emailToName": "acmegroup",
6   "entityIds": [
7     "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
8     "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
9   ],
10   "foreignId": "your-group-id",
11   "name": "AcmeConglomerate"
12 }'

200Successful

1 {
2   "id": "entg_a3582b70-fd04-4888-9185-a640ae9048be",
3   "entities": [
4     {
5       "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
6       "name": "Acme Inc.",
7       "email": "customer@acme.com",
8       "isCustomer": true,
9       "accountType": "business",
10       "profile": {
11         "business": {
12           "legalBusinessName": "Acme Inc.",
13           "taxIDProvided": true,
14           "email": "customer@acme.com",
15           "businessType": "llc",
16           "phone": {
17             "countryCode": "1",
18             "number": "4155551234"
19           },
20           "address": {
21             "addressLine1": "123 Main St",
22             "city": "San Francisco",
23             "stateOrProvince": "CA",
24             "postalCode": "94105",
25             "addressLine2": "Unit 1",
26             "country": "US"
27           },
28           "ownersProvided": true
29         }
30       },
31       "status": "verified",
32       "acceptedTos": true,
33       "isPayor": true,
34       "isPayee": false,
35       "isNetworkPayor": false,
36       "isNetworkPayee": false,
37       "createdAt": "2024-01-01T00:00:00Z",
38       "updatedAt": "2024-01-02T00:00:00Z",
39       "foreignId": "MY-DB-ID-12345"
40     },
41     {
42       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
43       "name": "Big Box Store",
44       "email": "vendor@bigboxstore.com",
45       "isCustomer": false,
46       "accountType": "business",
47       "profile": {
48         "business": {
49           "legalBusinessName": "Big Box Store",
50           "taxIDProvided": false,
51           "email": "vendor@bigboxstore.com",
52           "businessType": "publicCorporation",
53           "ownersProvided": false
54         }
55       },
56       "status": "unverified",
57       "acceptedTos": false,
58       "isPayor": false,
59       "isPayee": true,
60       "isNetworkPayor": false,
61       "isNetworkPayee": false,
62       "createdAt": "2024-01-01T00:00:00Z",
63       "updatedAt": "2024-01-02T00:00:00Z",
64       "foreignId": "MY-DB-ID-90909"
65     }
66   ],
67   "foreignId": "your-group-id",
68   "name": "AcmeConglomerate",
69   "emailToName": "acmegroup"
70 }

Built with

1	curl -X POST https://api.mercoa.com/entityGroup \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"emailToName": "acmegroup",
6	"entityIds": [
7	"ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
8	"ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
9	],
10	"foreignId": "your-group-id",
11	"name": "AcmeConglomerate"
12	}'

1	{
2	"id": "entg_a3582b70-fd04-4888-9185-a640ae9048be",
3	"entities": [
4	{
5	"id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
6	"name": "Acme Inc.",
7	"email": "customer@acme.com",
8	"isCustomer": true,
9	"accountType": "business",
10	"profile": {
11	"business": {
12	"legalBusinessName": "Acme Inc.",
13	"taxIDProvided": true,
14	"email": "customer@acme.com",
15	"businessType": "llc",
16	"phone": {
17	"countryCode": "1",
18	"number": "4155551234"
19	},
20	"address": {
21	"addressLine1": "123 Main St",
22	"city": "San Francisco",
23	"stateOrProvince": "CA",
24	"postalCode": "94105",
25	"addressLine2": "Unit 1",
26	"country": "US"
27	},
28	"ownersProvided": true
29	}
30	},
31	"status": "verified",
32	"acceptedTos": true,
33	"isPayor": true,
34	"isPayee": false,
35	"isNetworkPayor": false,
36	"isNetworkPayee": false,
37	"createdAt": "2024-01-01T00:00:00Z",
38	"updatedAt": "2024-01-02T00:00:00Z",
39	"foreignId": "MY-DB-ID-12345"
40	},
41	{
42	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
43	"name": "Big Box Store",
44	"email": "vendor@bigboxstore.com",
45	"isCustomer": false,
46	"accountType": "business",
47	"profile": {
48	"business": {
49	"legalBusinessName": "Big Box Store",
50	"taxIDProvided": false,
51	"email": "vendor@bigboxstore.com",
52	"businessType": "publicCorporation",
53	"ownersProvided": false
54	}
55	},
56	"status": "unverified",
57	"acceptedTos": false,
58	"isPayor": false,
59	"isPayee": true,
60	"isNetworkPayor": false,
61	"isNetworkPayee": false,
62	"createdAt": "2024-01-01T00:00:00Z",
63	"updatedAt": "2024-01-02T00:00:00Z",
64	"foreignId": "MY-DB-ID-90909"
65	}
66	],
67	"foreignId": "your-group-id",
68	"name": "AcmeConglomerate",
69	"emailToName": "acmegroup"
70	}