API

Sales APIs

POST sales/customer-groups/{customerGroupId}/members

Add a member to the given customer group

HTTP method POST
URI https://api.rambase.net/sales/customer-groups/{customerGroupId}/members
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {customerGroupId} Customer group identificator
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2467, version 3

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Member>
2
     <Customer>
3
          <CustomerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

>{Integer}</CustomerId>
4
     </Customer>
5
</Member>
1
{
2
     "member": {
3
          "customer": {
4
               "customerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

": "{Integer}"
5
          }
6
     }
7
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Member>
2
     <MemberId
MemberId

Group member identifier

>{Integer}</MemberId>
3
     <Status
Status

Group membership status

>{Integer}</Status>
4
     <AddedAt
AddedAt

Date and time of creation

>{Datetime}</AddedAt>
5
     <RemovedAt
RemovedAt

Datetime when group member was removed

>{Datetime}</RemovedAt>
6
     <Customer>
7
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
8
          <Status
Status

Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

>{Integer}</Status>
9
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
10
          <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
11
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
12
     </Customer>
13
     <AddedBy>
14
          <UserId
UserId

User identifier

>{Integer}</UserId>
15
          <Name
Name

Name of the user

>{String}</Name>
16
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
17
          <UserLink
UserLink

User reference

>{String}</UserLink>
18
     </AddedBy>
19
     <RemovedBy>
20
          <UserId
UserId

User identifier

>{Integer}</UserId>
21
          <Name
Name

Name of the user

>{String}</Name>
22
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
23
          <UserLink
UserLink

User reference

>{String}</UserLink>
24
     </RemovedBy>
25
</Member>
1
{
2
     "member": {
3
          "memberId
MemberId

Group member identifier

": "{Integer}",
4
          "status
Status

Group membership status

": "{Integer}",
5
          "addedAt
AddedAt

Date and time of creation

": "{Datetime}",
6
          "removedAt
RemovedAt

Datetime when group member was removed

": "{Datetime}",
7
          "customer": {
8
               "customerId
CustomerId

Customer identifier

": "{Integer}",
9
               "status
Status

Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

": "{Integer}",
10
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
11
               "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
12
               "customerLink
CustomerLink

Customer reference

": "{String}"
13
          },
14
          "addedBy": {
15
               "userId
UserId

User identifier

": "{Integer}",
16
               "name
Name

Name of the user

": "{String}",
17
               "firstName
FirstName

First name of the user

": "{String}",
18
               "userLink
UserLink

User reference

": "{String}"
19
          },
20
          "removedBy": {
21
               "userId
UserId

User identifier

": "{Integer}",
22
               "name
Name

Name of the user

": "{String}",
23
               "firstName
FirstName

First name of the user

": "{String}",
24
               "userLink
UserLink

User reference

": "{String}"
25
          }
26
     }
27
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects