1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Organization Members

updateMember

put

/ccagent/v1/organizationMembers/{id}

Update Member. This operation is used to update customer name, email, role, status and dynamic properties of a customer profile. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Also it takes X-CCOrganization header which is a JSON field with organization ID as value.If this header is not provided, then the endPoint will consider first active organization as the current organization.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateMember_request
Type: object
Show Source
Example:
{
    "dynamicProperty":"dynamicProperty value",
    "firstName":"kim",
    "lastName":"Anderson",
    "customerContactId":"CRMID_1",
    "roles":[
        {
            "function":"buyer"
        },
        {
            "function":"custom",
            "repositoryId":"customOrganizationalRole"
        }
    ],
    "receiveEmail":"yes",
    "active":true,
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977"
}
Nested Schema : roles
Type: array
List of role's function that need to associate with the user
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateMember_response
Type: object
Show Source
Nested Schema : parentOrganization
Type: object
This attribute is added for 'Account-Based Commerce', this is required only in case of 'Account-Based Commerce', this is the id of organization to which user is associated
Show Source
Nested Schema : roles
Type: array
List of user roles
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
Nested Schema : secondaryAddresses
Type: object
List of shipping addresses associated with the profile.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
Nested Schema : AddressType
Type: object
Address type represents nick-name of address.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : relativeTo
Type: object
Organization in which the role applies. Present only if type is organizationalRole
Show Source
Example Response (application/json)
{
    "lastName":"Dilliard",
    "GDPRProfileP13nConsentDate":"2018-03-23T09:02:31.000Z",
    "GDPRProfileP13nConsentGranted":true,
    "customerContactId":"CRMID_1",
    "dynamicProperties":[
        {
            "uiEditorType":"shortText",
            "default":"Field1",
            "length":null,
            "id":"dynamicProperty1",
            "label":"Nickname",
            "type":"string",
            "value":"dynamicPropertyValue",
            "required":false
        }
    ],
    "roles":[
        {
            "function":"admin",
            "relativeTo":"or-100001",
            "repositoryId":"100001"
        },
        {
            "function":"buyer",
            "relativeTo":"or-100001",
            "repositoryId":"100002"
        }
    ],
    "receiveEmail":"yes",
    "active":true,
    "locale":"en",
    "parentOrganization":{
        "active":true,
        "description":null,
        "secondaryAddresses":{
            "Address2":{
                "repositoryId":"ci-110024"
            },
            "Address1":{
                "repositoryId":"ci-110023"
            }
        },
        "externalOrganizationId":"EXT_ORG_1",
        "orderPriceLimit":50,
        "approvalRequired":true,
        "repositoryId":"or-100001",
        "punchoutUserId":"100012",
        "name":"National Discount Auto Parts",
        "shippingAddress":{
            "repositoryId":"ci-110024"
        },
        "billingAddress":{
            "repositoryId":"ci-110024"
        },
        "id":"or-100001",
        "useExternalApprovalWebhook":false
    },
    "receiveEmailDate":"2018-03-23T09:02:22.000Z",
    "orderPriceLimit":50,
    "firstName":"Leota",
    "profileType":"b2b_user",
    "repositoryId":"bb-110006",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/organizationMembers/bb-110006"
        }
    ],
    "id":"bb-110006",
    "secondaryOrganizations":[
    ],
    "email":"leota@example.com"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |22000|If the profile id passed is null or empty| |23012|If no last name is specified| |22001|If there was any internal error while getting the profile| |23013|If no first name is specified| |22002|If there was no profile found with the given id| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |200019|If an account already exists for the given email address| |23006|If invalid email address is specified| |22007|If the profile id passed is not associated to the account of the profile id passed in the AgentContext header| |22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.| |89103|If no shopperProfileId is passed in the AgentContext header| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive| |89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account| |13036|One of the dynamic properties is not writable by the Agent user|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top