Skip to content
Tallyraydocs

Add an outside address and mail it a confirmation, good 7 days: the workspace's owner. It gets nothing until its owner confirms

POST
/v1/buyer/reports/recipients
curl --request POST \
  --url https://example.com/v1/buyer/reports/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example" }'

Who: a workspace’s owner. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
<= 64 characters

Made once per action and sent again on every retry of it, so the service acts once: the request_id of the create or money-moving call; a new one when left out

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string

Example generated

{
  "email": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
asked
required
integer format: int32
asked_at
required
string | null format: date-time
confirmed_at
required
string | null format: date-time
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
id
required
integer format: int64
schedules
required
integer format: int32
status
required
string | null
Allowed values: asked confirmed lapsed
updated_at
required
string format: date-time
workspace_id
required
integer format: int64

Example 

{
  "created_by": {
    "kind": "user"
  },
  "status": "asked"
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}