Add vendors to a group

Request

Adds one or more vendors from the caller's directory to a vendor group and returns the group's resulting state, scoped server-side to the caller's organization. Requires an Idempotency-Key header (enforced at the gateway); a vendor id already a member of the group is a no-op rather than an error. Capped at 500 vendor_ids per call.

Path

idstringrequired

Vendor group to add members to (bound from the {id} path parameter).

Bodyapplication/jsonrequired

vendorIdsArray of stringsrequired

Vendor ids to add. Required, non-empty, capped at 500 per call. A vendor already a member is a no-op, not an error.

curl -i -X POST \
  'https://docs.titanapi.securityscorecard.io/_mock/openapi.public/public/v1/vendors/groups/{id}/vendors' \
  -H 'Content-Type: application/json' \
  -d '{
    "vendorIds": [
      "string"
    ]
  }'

Responses

A successful response.

Bodyapplication/json

vendorGroupobject(VendorGroup)required

A vendor group in the caller's vendor directory, curated for public API consumers. A vendor group is the customer's own named collection over the third parties they track (e.g. by business unit or risk tier).

Response

{
  "vendorGroup": {
    "id": "string",
    "name": "string",
    "description": "string",
    "memberCount": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}