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:          Wed, 13 Oct 2021 04:26:34 GMT

{
    "data": {
        "type": "group",
        "id": "4b6be620-3c39-428c-b7f8-8022ac393a5e",
        "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:          Wed, 13 Oct 2021 04:26:34 GMT

{
    "data": {
        "type": "group",
        "id": "4b6be620-3c39-428c-b7f8-8022ac393a5e",
        "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:          Wed, 13 Oct 2021 04:26:34 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:          Wed, 13 Oct 2021 04:26:34 GMT

{
    "meta": {
        "message": "Accepted"
    }
}