SetMonthlyProfiles (REST)

SetMonthlyProfiles allows the addition of multiple profiles to an existing monthly account. The available profiles will be gathered from GetMonthlyProfiles and must be submitted using JSON within the API call.

POST #

POST /api/monthly/SetMonthlyProfiles #

securityToken: "string"

{
  "Json": [
    {
      "ExternalID": "string",
      "ProfileID": "00000000-0000-0000-0000-000000000000",
      "ValidFrom": "2025-11-19T14:31:04.544Z",
      "ValidTo": "2025-11-19T14:31:04.544Z"
    }
  ],
  "LocationId": "string"
}

Parameters #

Note that the json field is used to provide an array of profile settings for a monthly account. In this way, you can provide more than one profile setting for an account.

Value	Description	Data Type
securityToken	We provide you with a security token. Note that this security token will differ from location to location. Your security token for the Monthly API is not used globally across all locations. We will provide you with a different security token per each location you create monthly accounts for.	string
ExternalID	The account external ID for the account to set profiles on	string
ProfileID	The ID of the profile to add to the account	string
ValidFrom	The time the profile will start being valid, in an ISO date-time string in UTC time, for example: 2020-07-13T01:00:00-05:00 yyyy-mm-ddThh:mm:ss	datetime
ValidTo	The time the profile will expire (also an ISO date-time string in UTC time)	datetime
LocationId	We provide you with a location ID. The location ID corresponds with the location you are creating or editing monthly accounts for.	string (GUID format)

Response #

Example #

{
  "Code": "Success",
  "Message": "string",
  "LocationProfiles": [
    {
      "UniqueID": "00000000-0000-0000-0000-000000000000",
      "Name": "string"
    }
  ]
}

Parameters #

The response should include a SetMonthlyProfilesResult object with the following data:

Field	Description
Code	If the request succeeded, the value of RESULT_CODE will be Success. If the request failed, a relevant error code will be provided.
Message	A message with clarifying information about the result is provided in this field