Create an address
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Body Parameters
Label for the address, e.g. "Bag End".
Second address line.
Whether this is the company default address.
Setting this to true moves the flag: the previous holder is cleared and the call returns 200/201. Unsetting the last one is a 400.
Setting this to true moves the flag: the previous holder is cleared and the call returns 200/201. Unsetting the last one is a 400.
personal and manual are rejected with 400 on create and update: they are per-user records, and a machine caller cannot own one. Existing rows of those types stay readable.
companybillingshippingofficeResponse
Created. The body is the read shape, with relations nested.
Response Attributes
Label for the address, e.g. "Bag End".
Second address line.
Whether this is the company default address.
Setting this to true moves the flag: the previous holder is cleared and the call returns 200/201. Unsetting the last one is a 400.
Setting this to true moves the flag: the previous holder is cleared and the call returns 200/201. Unsetting the last one is a 400.
All six types are readable. Only company, billing, shipping and office can be written, see the write payload.
companybillingshippingpersonalofficemanualWhen the row was created.
When the row itself last changed.
null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.
Validation failed. attr names the field, in snake_case.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError