List message sender assignments

Request

Security

OAuth2(Required scopes: FullAccessMessageConfigAssignmentAdminMessageSenderAdmin)

Query

buyerIDstring

ID of the buyer.

messageSenderIDstring

ID of the message sender.

userGroupIDstring

ID of the user group.

levelstring

Level of the message sender assignment. Possible values: Group, Company, BuyerGroup.

Enum:"Group""Company"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

pageSizeinteger

Number of results to return per page.

supplierIDstring

ID of the supplier.

curl -i -X GET \
  'https://api.ordercloud.io/v1/messagesenders/assignments?buyerID=string&messageSenderID=string&userGroupID=string&level=Group&page=0&pageSize=0&supplierID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(MessageSenderAssignment)

Example:

[
  {
    "MessageSenderID": "",
    "BuyerID": "",
    "SupplierID": "",
    "UserGroupID": "",
    "MessageConfigName": "",
    "MessageConfigDescription": ""
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}