This API finalizes the group invitation by adding the user to the group.
https://accounts./accounts.groups.finalizeInvitation
Where is:
If you are not sure of your site's data center, see Finding Your Data Center.
{
"callId": "26254b038410468bb5a3a344134fd88b",
"errorCode": 0,
"apiVersion": 2,
"statusCode": 200,
"statusReason": "OK",
"time": "2018-12-11T12:52:24.250Z"
}
Prior to calling this API, make sure to set the “invitation URL” by calling accounts.groups.setSiteConfig REST.
Certain APIs are not supported on all data centers. The specific API documentation will define if there are any data center
restrictions for the API.
Required Name Type Description
token string The invitation token.
uid string The user ID assigned to the group invitation.
The uid or login_token are required.
login_token string The login token for the user assigned to the group invitation.
The uid or login_token are required.
format string Determines the format of the response.
json (default)
context string/JSON This parameter may be used to pass data through the current method and return it,
unchanged, within the response.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in
SAP Customer Data Cloud's response is always 200 (OK), even if an error occurs. The
error code and message is given within the response data (see below). If this parameter is
set to true, the HTTP status code in SAP Customer Data Cloud's response would reflect an
error, if one occurred.
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as
client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your
implementation when using server-to-server REST calls, it is Recommended Best Practice to always use an application key and
secret or a bearer token when sending requests. A non-exhaustive list of REST APIs that this may apply to are as follows:
Please refer to the Authorization Parameters section for details.
As of January 31, 2023, you may no longer use a Partner Secret as a valid authentication method for requests to SAP Customer
Data Cloud servers.
Name Type Description
apiVersion integer Defines the API version that returned the response and may not always be available.
callId string Unique identifier of the transaction, for debugging purposes.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a
complete list of error codes, see the Error Codes table.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will
appear in the response only in case of an error.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always
returned and should not be relied upon by your implementation.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or 2021-03-
05T06:11:31.513Z
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
Name Type Description
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.
model string The group's model.
groupId string The group's ID.
Returns the user's groups.
https://accounts./accounts.groups.getAllMemberGroups
Where is:
If you are not sure of your site's data center, see Finding Your Data Center.
"callId": "17e71c8375614cd1bfe55a4e0122c049",
"errorCode": 0,
"apiVersion": 2,
"statusCode": 200,
"statusReason": "OK",
"time": "2022-06-14T15:10:44.042Z",
"model": "Family",
"groupId": "Gur"
}
Certain APIs are not supported on all data centers. The specific API documentation will define if there are any data center
restrictions for the API.
Required Name Type Description
UID string The SAP Customer Data Cloud UID of the user.
The UID is optional if you pass the login token otherwise it is required.
format string Determines the format of the response.
json (default)
context string/JSON This parameter may be used to pass data through the current method and return it,
unchanged, within the response.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in
SAP Customer Data Cloud's response is always 200 (OK), even if an error occurs. The
error code and message is given within the response data (see below). If this parameter is
set to true, the HTTP status code in SAP Customer Data Cloud's response would reflect an
error, if one occurred.
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as
client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your
implementation when using server-to-server REST calls, it is Recommended Best Practice to always use an application key and
secret or a bearer token when sending requests. A non-exhaustive list of REST APIs that this may apply to are as follows:
Please refer to the Authorization Parameters section for details.
As of January 31, 2023, you may no longer use a Partner Secret as a valid authentication method for requests to SAP Customer
Data Cloud servers.
Name Type Description
apiVersion integer Defines the API version that returned the response and may not always be available.
callId string Unique identifier of the transaction, for debugging purposes.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete
list of error codes, see the Error Codes table.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will
appear in the response only in case of an error.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or 2021-03-
05T06:11:31.513Z
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.
Name Type Description
results array An array of groups the user is a member of, with the user's membership details.
This API returns all existing models for the requested API key.
https://accounts./accounts.groups.getAllModels
Where is:
If you are not sure of your site's data center, see Finding Your Data Center.
"callId": "b42093126efa4c0fb8f9651a570a928c",
"errorCode": 0,
"apiVersion": 2,
"statusCode": 200,
"statusReason": "OK",
"time": "2022-08-17T13:57:05.305Z",,
"results": [
{
"groupId": "123",
"model": "OrgModel111",
"relationshipData": {},
"memberSince": "2022-08-16T14:54:04.486Z",
"lastUpdated": "2022-08-16T14:54:04.486Z",
"memberSinceTimestamp": 1660661644486,
"lastUpdatedTimestamp": 1660661644486,
"permissions": "groupRead,groupWrite,groupDelete",
"groupData": {
"zipcode": "123456",
"country": "Israel",
"membersLimit": 300,
"city": "Tel Aviv",
"streetaddress": "street1",
"source": "IMPORT",
"state": "Israel",
"type": "CUSTOMER"
}
}
]
}
Required Name Type Description
includeEmailTemplates boolean This parameter is optional, if true the model's groupInviteConfig data is included in the
response.
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as
client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your
implementation when using server-to-server REST calls, it is Recommended Best Practice to always use an application key and
secret or a bearer token when sending requests. A non-exhaustive list of REST APIs that this may apply to are as follows:
Please refer to the Authorization Parameters section for details.
Certain APIs are not supported on all data centers. The specific API documentation will define if there are any data center
restrictions for the API.
For details on the group invitation flow, see the Group Invitation section on the Email
Templates page.
As of January 31, 2023, you may no longer use a Partner Secret as a valid authentication method for requests to SAP Customer
Data Cloud servers.
Name Type Description
apiVersion integer Defines the API version that returned the response and may not always be returned.
callId string Unique identifier of the transaction, for debugging purposes.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a
complete list of error codes, see the Error Codes table.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will
appear in the response only in case of an error.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always
returned and should not be relied upon by your implementation.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or 2021-03-
05T06:11:31.513Z
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
Name Type Description
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.
models array An array containing all the existing models for the requested API key.
model - Model name
selfProvisioning - If true the group based on this model can be created by users, otherwise users can
not create a new group based on this model.
groupInviteConfig - The group invitation configuration details. The configuration details will be
returned if includeEmailTemplates is set to true in the parameters.
"callId": "dbc9910f05a246878d128c50773e180b",
"errorCode": 0,
"apiVersion": 2,
"statusCode": 200,
"statusReason": "OK",
"time": "2022-06-20T09:22:18.362Z",
"models": [
{
"model": "Model 2",
"selfProvisioning": false,
groupInviteConfig: {
"landingPage": "http://localhost/melodi",
"expiration": 300,
"defaultLang": "en",
"emailTemplates": {
"en": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
"de": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
"it": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
}
}
},
{
"model": "modal-one",
"selfProvisioning": false,
groupInviteConfig: {
"landingPage": "http://localhost/Ivori",
"expiration": 300,
"defaultLang": "en",
"emailTemplates": {
"en": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
"de": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
"it": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
}
}
},
{
"model": "test-00001",
"selfProvisioning": false,
groupInviteConfig: {
"landingPage": "http://localhost/Jays",
"expiration": 300,
"defaultLang": "en",
"emailTemplates": {
"en": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
"de": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
"it": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><META name=\"from\" conte
}
}
}
This API returns the information for an existing Group.
https://accounts./accounts.groups.getGroupInfo
Where is:
If you are not sure of your site's data center, see Finding Your Data Center.
Required Name Type Description
model string The model this group is based upon.
groupId string The groupId of the group to return.
Each REST API request must contain identification and authorization parameters.