Skip to content
Tallyraydocs

Invite a person to your workspace as a buyer or a viewer: its owner

POST
/v1/buyer/members
curl --request POST \
  --url https://example.com/v1/buyer/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "invitee": { "email": "example", "name": "example", "time_zone": "example" }, "role": "admin" }'

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
invitee
required
object
email
required
string
name
required
string
time_zone
required
string
role
required
string
Allowed values: admin manager affiliate advertiser buyer viewer support

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
account
required
object
id
integer format: int64
kind
required
string | null
Allowed values: network affiliate advertiser service workspace
account_name
required
string
created_at
required
string | null 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
id
string
owner
required
boolean
role
required
string | null
Allowed values: admin manager affiliate advertiser buyer viewer support
status
required
string | null
Allowed values: invited active
updated_at
required
string | null format: date-time
user
Any of:
object
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
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time
user_id
required
string

Example 

{
  "account": {
    "kind": "network"
  },
  "created_by": {
    "kind": "user"
  },
  "role": "admin",
  "status": "invited",
  "user": {
    "created_by": {
      "kind": "user"
    },
    "status": "invited"
  }
}

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"
  }
}