Skip to content

CompanyResponse

Type: object

Company record. May include any additional fields listed in the corresponding describe method

Properties

Property Type Required Description Constraints
id integer (int64) Yes Unique integer id of the company record
reasons array No List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted
seq integer (int32) Yes Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.
status string No Status of the operation performed on the record enum: created, updated, deleted, skipped, added, removed

Generated example

{
  "id": 123,
  "reasons": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "seq": 123,
  "status": "created"
}

Referenced models

Source

Generated from swagger-mapi.json.