Add File to Attachment or Image Group Attribute (POST)

Allows a file or image to be attached to an attribute for a group of people in the Organization module.

 

URL

{RMUrl}/api/organization/groups/<GroupID>/attributes/<AttributeVariableName>/files

 

REQUEST METHOD

POST

 

URL PARAMETERS

GroupID: This parameter is provided in the URL and does not need to be sent through POST.

AttributeVarName: This parameter is provided in the URL and does not need to be sent through POST.

 

FORM CONTENT

FileName (Required): Name used to identify the attachment.

Data (Required): File to be attached to the attribute. The maximum file size is 10 MB. The file bytes must be converted to a base64 string before sending.

Description (Optional): Optional comment for the attachment.

 

REQUEST EXAMPLE

{RMUrl}/api/organization/groups/78395d3d-d7e6-4938-9682-b5bd3c5be422/attributes/attachmentattribute/files

 

FORM CONTENT EXAMPLE

{
"FileName": "Receipt.pdf",
"Data": "TWFuIGlzIGR...WQsIG5vdCBvbm",
"Description": "Proof of payment sent."
}

 

SUCCESS RESPONSE

The ID of the file attached. Returns a Guid.

 

SUCCESS RESPONSE EXAMPLE

"443de4ae-2360-4b66-bf69-8c9e4ca09001"