Update Organization
PUT/api/v1/organizations/:organization_id
Update Organization
Request​
Path Parameters
- application/json
Body
Array [
]
Possible values: non-empty
Organization address line 1
Organization address line 2
Billing email
City where the organization locates
contacts
object[]
required
Possible values: >= 1
Organization contact information
Email of the organization contact
Possible values: non-empty
First name of the organization contact
Last name of the organization contact
Phone number of the organization contact
Work phone number of the organization contact
ISO Alpha-2 country code
location
object
nullable
Organization location
Latitude of the organization location
Longitude of the organization location
Possible values: non-empty
Name of the organization
Office ID
Possible values: non-empty
Organization phone number
Organization postal code
Province where the organization locates
Possible values: non-empty
Support F(Factory) S(Supplier) B(Brand) R(Retailer) V(Vendor)
description of the local organization
Responses​
- 200
- 400
- 401
- 422
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object
Possible values: non-empty
Organization address line 1
Organization address line 2
Billing email
City where the organization locates
contacts
object[]
required
Possible values: >= 1
Organization contact information
Email of the organization contact
Possible values: non-empty
First name of the organization contact
Last name of the organization contact
Phone number of the organization contact
Work phone number of the organization contact
ISO Alpha-2 country code
Creation date and time of the organization in the system
Possible values: non-empty
Global organization that links to this local organization
location
object
nullable
Organization location
Latitude of the organization location
Longitude of the organization location
Possible values: non-empty
Name of the organization
Office ID
Possible values: non-empty
Organization phone number
Organization postal code
Province where the organization locates
Possible values: non-empty
Support F(Factory) S(Supplier) B(Brand) R(Retailer) V(Vendor)
Last updated date and time of the organization in the system
description of the local organization
{
"data": {
"address": "5 Madison Avenue",
"address2": "Suite 101",
"billing_email": "[email protected]",
"city": "New York",
"contacts": [
{
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phone": "1505123123",
"workPhone": "1505456456"
}
],
"country": "US",
"createdAt": "2021-06-02 12:34:02.861000+00:00",
"id": "string",
"linkedTo": "3111222",
"location": {
"latitude": 38.8951,
"longitude": -77.0364
},
"name": "Acme Corp",
"officeId": "office_123",
"phone": "1505111222",
"postal": "A1B2C3",
"province": "New York",
"type": "S",
"updatedAt": "2021-06-02 12:34:02.861000+00:00",
"description": "This is a description"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Cannot retrieve session data because of expired token"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"type": [
"Input type is not valid"
]
},
"message": "Validation error"
}
Rate-limiting Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Too many requests"
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"system": [
"Internal error detail message"
]
},
"message": "Internal server error"
}