Group
A group represent a collection of candidates.
Create
Create a new group.
Request
POST /api/groups
Host: api.happyrmatch.com
Authorization: Bearer eyJ0eXAi1QiLCJ...
Accept: application/vnd.api+json
Response
HTTP/1.0 201 Created
Cache-Control: no-cache, private
Content-Type: application/vnd.api+json
Date: Tue, 12 Jul 2022 07:33:06 GMT
{
"data": {
"type": "group",
"id": "c0a343be-2138-4ee5-8278-a3a4904052de",
"attributes": []
}
}
You can also create a group while adding candidates
Request
POST /api/groups
Host: api.happyrmatch.com
Authorization: Bearer eyJ0eXAi1QiLCJ...
Accept: application/vnd.api+json
{
"candidates": [
"[candidate_id]",
"[candidate_id]"
]
}
Response
HTTP/1.0 201 Created
Cache-Control: no-cache, private
Content-Type: application/vnd.api+json
Date: Tue, 12 Jul 2022 07:33:06 GMT
{
"data": {
"type": "group",
"id": "c0a343be-2138-4ee5-8278-a3a4904052de",
"attributes": []
}
}
Add candidates
Add candidates to a group.
Request
POST /api/groups/[group_id]/candidates
Host: api.happyrmatch.com
Authorization: Bearer eyJ0eXAi1QiLCJ...
Accept: application/vnd.api+json
{
"candidates": [
"[candidate_id]",
"[candidate_id]"
]
}
Response
HTTP/1.0 202 Accepted
Cache-Control: no-cache, private
Content-Type: application/vnd.api+json
Date: Tue, 12 Jul 2022 07:33:06 GMT
{
"meta": {
"message": "Accepted"
}
}
Remove candidates
Remove a candidate from a group.
Request
DELETE /api/groups/[group_id]/candidates/[candidate_id]
Host: api.happyrmatch.com
Authorization: Bearer eyJ0eXAi1QiLCJ...
Accept: application/vnd.api+json
Response
HTTP/1.0 202 Accepted
Cache-Control: no-cache, private
Content-Type: application/vnd.api+json
Date: Tue, 12 Jul 2022 07:33:06 GMT
{
"meta": {
"message": "Accepted"
}
}