Rivier/ Reference/ workspace

Add a contact to a client (a name or an email address is needed

post/org/{orgId}/clients/{id}/contacts

Add a contact to a client (a name or an email address is needed; one can be primary, several can be copied by default).

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Mcp
rivier_clients_contact_add
Graphql
Mutation.workspaceOrgContactAdd
Sdk
workspace.orgContact.add
Cli
clients contacts add

Parameters

  • orgIdstring (uuid)required
    In the path
  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    Default: . At most 200 characters.
  • emailstring (email)
    Default: .
  • phonestring
    Default: . At most 60 characters.
  • rolestring
    Default: . At most 80 characters.
  • isPrimaryboolean
    Default: false.
  • ccDefaultboolean
    Default: false.

Responses

  • 201application/json
    Success
    • contactobjectrequired
      • idstring (uuid)required
      • clientIdstring (uuid)required
      • namestringrequired
      • emailstringrequired
      • phonestringrequired
      • rolestringrequired
      • isPrimarybooleanrequired
      • ccDefaultbooleanrequired
      • createdAtstringrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown