Agents

---

Show a list of agents belonging to this partner

GET /api/v1/partners/:api_token/agents

Return a list of agents created by this partner, sorted by newest first.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents

Headers

Header name	Description
X-API-SECRET optional	API secret of your organization

---

Show an agent belonging to this partner

GET /api/v1/partners/:api_token/agents/:id

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents/:id

Headers

Header name	Description
X-API-SECRET optional	API secret of your organization

---

Create a new agent under this partner

POST /api/v1/partners/:api_token/agents

Create a new agent account under this partner. Take note of the ID parameter in the returned Agent hash, it is how you will access this same agent later on.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents

{
  "agent": {
    "name": "Seoul Branch"
  }
}

Request Parameters

Name	Type	Description
agent required	Value: Must be a Hash	Agent Information
agent[name] optional	Value: Must be a String	Name of the Agent

Headers

Header name	Description
X-API-SECRET optional	API secret of your organization

---

Update the attributes of an agent belonging to this partner

PUT /api/v1/partners/:api_token/agents/:id

Update agent information.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents

{
  "agent": {
    "name": "Incheon Branch"
  }
}

Request Parameters

Name	Type	Description
agent required	Value: Must be a Hash	Agent Information
agent[name] optional	Value: Must be a String	Name of the Agent

Headers

Header name	Description
X-API-SECRET optional	API secret of your organization

---

Delete an agent belonging to this VENDOR partner

DELETE /api/v1/partners/:api_token/agents/:id

Delete an agent. This will not work if the agent has any users associated with it.

Headers

Header name	Description
X-API-SECRET optional	API secret of your organization