/api/v3/transaction/{tx_id}/roles/bulk

delete

https://api.sisu.co/api/v3/transaction/{tx_id}/roles/bulk

Delete multiple agent-role assignments from a transaction. Primary agent, TC, and ISA roles cannot be edited from this endpoint, use PATCH /transaction or PATCH /transaction/fields instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tx_id

integer

required

ID of the transaction.

Query Params

assignment_id

integer

ID of the agent-role assignment record(s) to delete. This is the assignment_record_id returned by GET /transaction/{tx_id}/roles. Accepts multiple values. Optional, but one of assignment_id, agent_id, or role_id must be provided.

agent_id

integer

ID of the agent(s) to remove from the transaction. Accepts multiple values. Optional, but one of assignment_id, agent_id, or role_id must be provided. If the selected agent is also the primary agent, TC, or ISA, only their custom roles will be removed.

role_id

integer

ID of the role(s) to remove from the transaction. Accepts multiple values. Optional, but one of assignment_id, agent_id, or role_id must be provided. If provided, all assignments to this role will be removed. Will not accept values for primary agent, TC, or ISA.

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success