Update Group | Mercoa | Documentation

curl -X POST https://api.mercoa.com/entityGroup/entg_a3582b70-fd04-4888-9185-a640ae9048be \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "foreignId": "your-group-id",
  "name": "AcmeConglomerate",
  "emailToName": "acmegroup"
}'

{
  "id": "entg_a3582b70-fd04-4888-9185-a640ae9048be",
  "entities": [
    {
      "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
      "name": "Acme Inc.",
      "email": "customer@acme.com",
      "isCustomer": true,
      "accountType": "business",
      "profile": {
        "business": {
          "legalBusinessName": "Acme Inc.",
          "taxIDProvided": true,
          "email": "customer@acme.com",
          "businessType": "llc",
          "phone": {
            "countryCode": "1",
            "number": "4155551234"
          },
          "address": {
            "addressLine1": "123 Main St",
            "city": "San Francisco",
            "stateOrProvince": "CA",
            "postalCode": "94105",
            "addressLine2": "Unit 1",
            "country": "US"
          },
          "ownersProvided": true,
          "taxId": {
            "ein": {
              "number": "12-3456789"
            }
          }
        }
      },
      "status": "verified",
      "acceptedTos": true,
      "isPayor": true,
      "isPayee": false,
      "isNetworkPayor": false,
      "isNetworkPayee": false,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-02T00:00:00Z",
      "foreignId": "MY-DB-ID-12345"
    },
    {
      "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
      "name": "Big Box Store",
      "email": "vendor@bigboxstore.com",
      "isCustomer": false,
      "accountType": "business",
      "profile": {
        "business": {
          "legalBusinessName": "Big Box Store",
          "taxIDProvided": false,
          "email": "vendor@bigboxstore.com",
          "businessType": "publicCorporation",
          "ownersProvided": false
        }
      },
      "status": "unverified",
      "acceptedTos": false,
      "isPayor": false,
      "isPayee": true,
      "isNetworkPayor": false,
      "isNetworkPayee": false,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-02T00:00:00Z",
      "foreignId": "MY-DB-ID-90909"
    }
  ],
  "metadata": {
    "key1": "value1"
  },
  "foreignId": "your-group-id",
  "name": "AcmeConglomerate",
  "emailToName": "acmegroup"
}

Update an entity group

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityGroupIdstringRequired

Entity Group ID or Entity Group ForeignID

Request

This endpoint expects an object.

foreignIdstringOptional

namestringOptional

emailToNamestringOptional

metadatamap from strings to stringsOptional

Metadata key/value pairs to associate with this group. Will overwrite existing metadata.

Response

This endpoint returns an object.

idstring

entitieslist of objects

metadatamap from strings to strings

foreignIdstring

namestring

emailToNamestring

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented