Desk

Put one planned outreach touch (an email, LinkedIn or call step for one contact) on a rep's desk with its why, facts and draft. The rep edits and sends it; nothing sends by itself. owner_id must be the caller's own email unless the key is an org or machine key: a personal key or an OAuth connection is a person and gets 403 owner_not_self for anyone else. Posting the same external_key again updates the open card instead of adding a second one. Needs deals:write and a key allowed to see the contact

Put one planned touch on a rep's desk, with its why, facts, fields and draft.

201 when the card is made. The same touch posted again (same external_key, else the same list_id + contact_id + touch, else the same rep, contact, channel and due day) while the card is unsent answers 200 with the same card_id and updated: true. An external_key is kept apart per origin.kind, so two integrations may both use "1"; a body with no origin.kind shares one namespace with every other such caller in the org, so its key must be unique across the org. Once the rep has sent or decided it, a re-post makes a new card. A card the desk will not make is a 4xx whose detail.reason says why. A personal key may name only its own holder (403 owner_not_self); an org key may name any active rep. The key must be allowed to see the contact (and the account when one is named, else the contact's own company), checked the way the contacts and deals routes check a record id from a body; one it may not see is 403 contact_not_allowed / account_not_allowed and no card is made.

post/desk/cards

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/cards
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

owner_idstring required

Whose desk: a team member's email, id or user id. With a personal key or an OAuth connection this must be the caller's own email (the key is a person; anyone else is 403 owner_not_self). Only an org or machine key may name another rep.

contact_idinteger required

The contact the touch is for.

account_idinteger nullable

The contact's company, when it is not the contact's own.

channelstring required

email, linkedin or call.

due_atstring date-time nullable

When the touch is due. It orders the queue and never hides the card.

prioritystring

low, normal, high or urgent.

list_idinteger nullable
touchinteger nullable

The touch number in the list's cadence.

external_keystring nullable

Your own key for this touch. Posting it again updates the unsent card. Keys are kept apart by origin.kind; with no origin.kind the key must be unique across the org.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.