PUT /api/businesses/{BusinessID}

Updates information about a business on the platform.

Supported Versions: 8.3 and later

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the resource. Business Admin or other authorized Admin.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/businesses/{BusinessID}

Back to top

Sample Request

The example below shows a request to update the information for the specified business.

Request URL

https://{hostname}/api/businesses/75b2388a-d620-4863-a737-f1bf2f145f05.acmepaymentscorp

Sample request headers

PUT /api/businesses/75b2388a-d620-4863-a737-f1bf2f145f05.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/vnd.soa.v83+json
Content-Type: application/vnd.soa.v83+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "BusinessType":"Company",
  "Name":"ACME Payments API Company",
  "Description":"ACME Payments API Company, in business since 2011.",
  "PictureID":""
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

Any of the following media types is valid for the Accept header:

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

application/vnd.soa.v83+json or application/vnd.soa.v83+xml

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml

application/vnd.soa.v83+json or application/vnd.soa.v83+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
BusinessID Path string Required The unique ID for a specific business organization on the platform.
Business Body Business Required

Contains information about a business on the platform.

When updating, send the full business object: BusinessID, Name, Description, Visibility, AdminGroupID.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the updated information.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v83+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+json
Date: Thu, 10 Nov 2016 21:55:10 GMT

Sample response body: application/vnd.soa.v83+json

{
  "BusinessID" : "de35bef0-0e6b-4768-b62d-38fe1181b6ec.acmepaymentscorp",
  "Name" : "ACME Payments API Company",
  "Description" : "ACME Payments API Company, in business since 2011.",
  "Visibility" : "Limited",
  "AdminGroupID" : "bizadmin-de35bef0-0e6b-4768-b62d-38fe1181b6ec.acmepaymentscorp",
  "BusinessType" : "Company"
}

Back to top

Sample response headers: application/vnd.soa.v83+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+xml
Date: Thu, 10 Nov 2016 21:55:55 GMT

Sample response body: application/vnd.soa.v83+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Business xmlns="http://soa.com/xsd/business/1.0" xmlns:ns2="http://soa.com/xsd/legals/1.0" 
xmlns:ns3="http://soa.com/xsd/dnmodel/1.0" xmlns:ns4="http://soa.com/xsd/api/1.0">
  <BusinessID>de35bef0-0e6b-4768-b62d-38fe1181b6ec.acmepaymentscorp</BusinessID>
  <Name>ACME Payments API Company</Name>
  <Description>ACME Payments API Company, in business since 2011.</Description>
  <Visibility>Limited</Visibility>
  <AdminGroupID>bizadmin-de35bef0-0e6b-4768-b62d-38fe1181b6ec.acmepaymentscorp</AdminGroupID>
  <BusinessType>Company</BusinessType>
</Business>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

application/vnd.soa.v83+json or application/vnd.soa.v83+xml

Back to top

Response Body

Name Type Description
Business Business Contains information about a business on the platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
400 Bad request: Returned if the client sends invalid parameters or body content. For example, you might get this response if you send an incorrect JSON object in the request, or if you specify an incorrect content type that doesn't match the payload.
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics