Remove Contract Cc Recipient

Remove view-only (CC) recipient

Takes the address off the contract's CC list: its read-only view link stops
working immediately and it receives no further status emails. Cannot be
undone on this contract. Returns 404 if the request does not exist or the
address is not one of its CC recipients.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Remove a view-only (CC) recipient from a contract request. The address is taken off the contract's CC list: its read-only view link stops working immediately and it receives no further status emails for this contract. The removal cannot be undone on this contract. Returns the updated contract request.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • API credentials need the contracts.requests.write permission. Dashboard users need the OWNER or OPERATIONS role, or a custom role that includes this permission.
  • Contract signing must be enabled for the client. If it is disabled the request returns 403.

Path parameters

ParameterDescription
request_idID of the contract request. Must belong to your client.

Query parameters

ParameterTypeDescription
emailstring, required (3-320 characters)Address of the view-only (CC) recipient to remove. Matched without regard to case or surrounding spaces against the request's cc_recipients.

Behavior

  • Only the view-only (CC) list changes. Signers and the extra completion recipients in completion_extra_emails are not affected.
  • The request can be in any status, including completed, declined, expired and canceled.

CC recipients come from email_notifications.cc_emails on the contract flow the request was created from (see https://docs.urbanpayx.com/reference/create_workflow_api_v1_contracts_workflows_post), or on the send call (see https://docs.urbanpayx.com/reference/compose_and_send_contract_api_v1_contracts_send_post).

Response

200 - Returns the updated ContractRequestResponse. The removed address no longer appears in cc_recipients.

Error responses

StatusWhen
403Contract signing is disabled for the client
404No contract request with this request_id exists under your client, or email is not one of its CC recipients
422email is missing or outside the allowed length

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
Query Params
string
required
length between 3 and 320

Address of the view-only (CC) recipient to remove

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json