Skip to main content
POST

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

Pattern: ^grp_[0-9a-f]{12}$

Body

application/json
requested_by
string

The person on your side. Defaults to your partner name.

Maximum string length: 120
Example:

"pat@broker.example"

note
string
Maximum string length: 300

Response

The group already had a request; this is the first one.

group_id
string
required
Example:

"grp_8c2f41d09a3e"

move_forward
object
required