Modify existing business partners
The PUT /pic/link/business-partners/update
endpoint allows you to update business partners that will interact with the AppliQloud platform. ππΌπ€
Authorizationβ
This endpoint requires authentication through Basic Auth
with the username and password of the backend that will consume it. To create and configure a backend, follow the backends tutorial
Request parametersβ
- π£ Path
- π Query
- πͺ Body
This request does not contain parameters of type Path
This request does not contain parameters of type Query
JSON Bodyβ
{
"inputs": [
BusinessPartner
]
}
Name | Type | Default | Description |
---|---|---|---|
inputs | Array[ BusinessPartner ] | Required | List of business partners to create |
BusinessPartner
β
{
"externalId": string,
"name": string,
"email": string,
"identification": BusinessPartnerIdentification,
"businessPartnerTypeIds": [
string
],
"contacts":[
BusinessPartnerContact
]
}
Name | Type | Default | Description |
---|---|---|---|
externalId | string | Required | Identifier in the external system |
name | string | Required | Business partner name |
identification | BusinessPartnerIdentification | Required | Identification of the business partner |
businessPartnerTypeIds | Array[ BusinessPartnerType ] | Required | Business partner types |
contacts | Array[ BusinessPartnerContact ] | [] | Business partner contacts |
BusinessPartnerIdentification
β
Possible values: [COMPANY, PERSON]
BusinessPartnerType
β
Possible values: [VENDOR]
BusinessPartnerContact
β
{
"firstName": string,
"lastName": string,
"email": string
}
Name | Type | Default | Description |
---|---|---|---|
firstName | string | Required | Name of the new user |
lastName | string | Required | New user's last name |
email | string | Required | New user email |
This object is used to register a new user as a business partner contact. The request will return a status of 400 Bad Request
if the email is already associated with an existing user on the AppliQloud platform.
Examplesβ
- π₯οΈ cURL
curl --location 'https://<identifier>.api.appliqloud.com/pic/link/business-partners/update' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
"inputs": [
{
"externalId": "1245",
"name": "AppliQloud",
"email": "contact@appliqloud.com",
"identification": "COMPANY",
"businessPartnerTypeIds": [
"VENDOR"
],
"contacts":[
{
"firstName": "Juan",
"lastName": "PΓ©rez",
"email": "juan.perez@mail.com"
}
]
}
]
}'
Make sure to modify the <identifier>
and <token>
fields with your company identifier and authentication token respectively.
Responsesβ
- β 200
- β οΈ 201 (with errors)
- π 401
- π§ 500
The business partners were successfully updated
{
"success": [
{
"id": "32",
"name": "AppliQloud",
"email": "sales@appliqloud.com",
"status": "PENDING_COMPLETION",
"identification": "PERSON"
"businessPartnerTypeIds": [
"VENDOR"
],
"contacts": [
{
"userId": "jimenezd24",
"notificationChannels": [
"EMAIL"
]
}
],
"backendMappings": [
{
"backendId": "SAP",
"externalId": "6247"
}
]
}
],
"errors": []
}
There is an error in the request
{
"success": [],
"errors": [
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"cause": "BusinessPartnerNotFoundException",
"message": "Business partner with external identifier 6248 not found for backend SAP",
"context": {
"backendId": "6248",
"externalId": "SAP"
}
}
]
}
Authorization required or credentials are not correct
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"request": "POST /pic/business-partners",
"cause": "UnauthorizedException",
"message": "Authorization required"
}
Internal application error (contact support@appliqloud.com or open a support ticket)
{
"success": [],
"errors": [
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"cause": "InternalServerError",
"message": "Internal Server Error",
}
]
}