RelayAPI

Pin Whats App Group Message

POST
/v1/whatsapp/admin/groups/{group_id}/pins
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Path Parameters

group_id*string
Length1 <= length <= 512

Header Parameters

idempotency-key*string

Caller-generated key for one logical provider mutation. Reusing it with a different request is rejected.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/whatsapp/admin/groups/string/pins" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "account_id": "string",    "action": "pin",    "message_id": "string"  }'
{  "account_id": "string",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "error": "string",  "id": "string",  "kind": "string",  "platform": "string",  "provider_operation_id": "string",  "provider_post_id": "string",  "result": {    "property1": null,    "property2": null  },  "status": "pending",  "target_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Found something wrong? Help us improve this page.