Tags Endpoint
Endpoint Actions
The Tags Endpoint is used to classify a transaction with metadata tags for the purposes of filtering a group of transactions within your integrated solution. These fields can be subject matter related like a donation campaign or service type. These tags can be used as custom filters for the Transactions Endpoint.
Create Record
POST /v2/tags
Update Record
PUT /v2/tags/{id}
View Single Record
GET /v2/tags/{id}
View Record List
GET /v2/tags
Note: Filters can be used to search for Tags by including the columns you want to filter on as URL parameters. i.e. /v2/tags?field=value&field2=value2
Delete Record
DELETE /v2/tags
Fields
Name | Min | Max | Format | POST Required | POST Allowed | PUT Allowed | Comments |
---|---|---|---|---|---|---|---|
id | 24 | 36 | string | The tags unique identifier | |||
created_ts | 10 | integer | The created timestamp | ||||
location_id | 24 | 36 | sring | ✔ | ✔ | The location this tag belongs to | |
modified_ts | 10 | integer | The last modified timestamp | ||||
title | 1 | 64 | string | ✔ | ✔ | ✔ |
Expands (Related Records)
For detail on how to use expands on an endpoint, please visit the Expands (Related Records) page.
Related Record | Filter Name |
---|---|
Created User | created_user |
An example of “expanding” this endpoint to one of the above related records would look like this:
GET /v2/tags/xxxxxxxxxxxxxxxxxxxxxxxx?expand=location